fix: support github server url for pushing to fork (#1318)

* feat: support github server url for pushing to fork (#1315)

Co-authored-by: Kevin Zhu <kevin.zhu@sap.com>

* fix: code formatting

* test: fix tests for getRemoteUrl

Co-authored-by: MildC <kevin.xizhu@gmail.com>
Co-authored-by: Kevin Zhu <kevin.zhu@sap.com>

.eslintignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.eslintrc.json

@@ -0,0 +1,23 @@
+{
+  "env": { "node": true, "jest": true },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript",
+    "plugin:prettier/recommended"
+  ],
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/camelcase": "off"
+  },
+  "settings": {
+    "import/resolver": {
+      "typescript": {}
+    }
+  }
+}

.github/CODEOWNERS

@@ -1 +0,0 @@
-* @peter-evans

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: peter-evans

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,7 @@
+### Subject of the issue
+
+Describe your issue here.
+
+### Steps to reproduce
+
+If this issue is describing a possible bug please provide (or link to) your GitHub Actions workflow.

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    allow:
+      - dependency-name: "@actions/*"

.github/workflows/ci.yml

@@ -0,0 +1,134 @@
+name: CI
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+      - run: npm run format-check
+      - run: npm run lint
+      - run: npm run test
+      - uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - uses: actions/upload-artifact@v3
+        with:
+          name: action.yml
+          path: action.yml
+
+  test:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
+    needs: [build]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [built, committed]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: main
+      - if: matrix.target == 'built' || github.event_name == 'pull_request'
+        uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - if: matrix.target == 'built' || github.event_name == 'pull_request'
+        uses: actions/download-artifact@v3
+        with:
+          name: action.yml
+          path: .
+
+      - name: Create change
+        run: date +%s > report.txt
+
+      - name: Create Pull Request
+        id: cpr
+        uses: ./
+        with:
+          commit-message: '[CI] test ${{ matrix.target }}'
+          committer: GitHub <noreply@github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          title: '[CI] test ${{ matrix.target }}'
+          body: |
+            - CI test case for target '${{ matrix.target }}'
+
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          branch: ci-test-${{ matrix.target }}
+
+      - name: Close Pull
+        uses: peter-evans/close-pull@v2
+        with:
+          pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
+          comment: '[CI] test ${{ matrix.target }}'
+          delete-branch: true
+
+  commentTestSuiteHelp:
+    if: github.event_name == 'pull_request'
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Find Comment
+        uses: peter-evans/find-comment@v2
+        id: fc
+        with:
+          issue-number: ${{ github.event.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: Full test suite slash command
+
+      - if: steps.fc.outputs.comment-id == ''
+        name: Create comment
+        uses: peter-evans/create-or-update-comment@v2
+        with:
+          issue-number: ${{ github.event.number }}
+          body: |
+            Full test suite slash command (repository admin only)
+            ```
+            /test repository=${{ github.event.pull_request.head.repo.full_name }} ref=${{ github.event.pull_request.head.ref }} build=true
+            ```
+
+  package:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: 'build: update distribution'
+          title: Update distribution
+          body: |
+            - Updates the distribution for changes on `main`
+
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          branch: update-distribution

.github/workflows/cpr-example-command.yml

@@ -0,0 +1,49 @@
+name: Create Pull Request Example Command
+on:
+  repository_dispatch:
+    types: [cpr-example-command]
+jobs:
+  createPullRequest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Make changes to pull request
+        run: date +%s > report.txt
+
+      - name: Create Pull Request
+        id: cpr
+        uses: ./
+        with:
+          commit-message: Update report
+          committer: GitHub <noreply@github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          signoff: false
+          title: '[Example] Update report'
+          body: |
+            Update report
+            - Updated with *today's* date
+            - Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          labels: |
+            report
+            automated pr
+          assignees: peter-evans
+          reviewers: peter-evans
+          milestone: 1
+          draft: false
+          branch: example-patches
+          delete-branch: true
+
+      - name: Check output
+        run: |
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
+
+      - name: Add reaction
+        uses: peter-evans/create-or-update-comment@v2
+        with:
+          repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
+          comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
+          reaction-type: hooray

.github/workflows/create-pull-request-multi.yml

@@ -1,44 +0,0 @@
-name: Create Pull Request All Platforms
-on:
-  repository_dispatch:
-    types: [create-pull-request-multi]
-jobs:
-  createPullRequest:
-    name: Testing on ${{ matrix.platform }}
-    strategy:
-      matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
-    runs-on: ${{ matrix.platform }}
-    steps:
-      - uses: actions/checkout@v1
-      - name: Create report file
-        if:  matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
-        run: date +%s > report.txt
-      - name: Create report file (windows)
-        if:  matrix.platform == 'windows-latest'
-        run: echo %DATE% %TIME% > report.txt
-      - name: Create Pull Request
-        id: cpr
-        uses: ./
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: Add report file
-          author-email: peter-evans@users.noreply.github.com
-          author-name: Peter Evans
-          title: '[Example] Add report file'
-          body: |
-            New report
-            - Contains *today's* date
-            - Auto-generated by [create-pull-request][1]
-
-            [1]: https://github.com/peter-evans/create-pull-request
-          labels: report, automated pr
-          assignees: peter-evans
-          reviewers: peter-evans
-          milestone: 1
-          branch: example-patches
-          branch-suffix: random
-      - name: Check outputs
-        run: |
-          echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"

.github/workflows/create-pull-request.yml

@@ -1,36 +0,0 @@
-name: Create Pull Request
-on:
-  repository_dispatch:
-    types: [create-pull-request]
-jobs:
-  createPullRequest:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: Create report file
-        run: date +%s > report.txt
-      - name: Create Pull Request
-        id: cpr
-        uses: ./
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: Add report file
-          author-email: peter-evans@users.noreply.github.com
-          author-name: Peter Evans
-          title: '[Example] Add report file'
-          body: |
-            New report
-            - Contains *today's* date
-            - Auto-generated by [create-pull-request][1]
-
-            [1]: https://github.com/peter-evans/create-pull-request
-          labels: report, automated pr
-          assignees: peter-evans
-          reviewers: peter-evans
-          milestone: 1
-          branch: example-patches
-          branch-suffix: short-commit-hash
-      - name: Check outputs
-        run: |
-          echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"

.github/workflows/dockerhub-description.yml

@@ -1,16 +0,0 @@
-name: Update Docker Hub Description
-on:
-  push:
-    branches:
-    - master
-jobs:
-  dockerHubDescription:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v2.1.0
-      env:
-        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
-        DOCKERHUB_REPOSITORY: peterevans/create-pull-request

.github/workflows/slash-command-dispatch.yml

@@ -0,0 +1,37 @@
+name: Slash Command Dispatch
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  slashCommandDispatch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Slash Command Dispatch
+        uses: peter-evans/slash-command-dispatch@v3
+        with:
+          token: ${{ secrets.ACTIONS_BOT_TOKEN }}
+          config: >
+            [
+              {
+                "command": "test",
+                "permission": "admin",
+                "repository": "peter-evans/create-pull-request-tests",
+                "named_args": true
+              },
+              {
+                "command": "clean",
+                "permission": "admin",
+                "repository": "peter-evans/create-pull-request-tests"
+              },
+              {
+                "command": "cpr-example",
+                "permission": "admin",
+                "issue_type": "issue"
+              },
+              {
+                "command": "rebase",
+                "permission": "admin",
+                "repository": "peter-evans/slash-command-dispatch-processor",
+                "issue_type": "pull-request"
+              }
+            ]

.gitignore

@@ -1,2 +1,5 @@
-node_modules
+lib/
+node_modules/
+
 .DS_Store
+.idea

.prettierignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "arrowParens": "avoid",
+  "parser": "typescript"
+}

README.md

@@ -1,5 +1,6 @@
-# <img width="24" height="24" src="assets/logo.svg"> Create Pull Request
-[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Create%20Pull%20Request-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/create-pull-request)
+# <img width="24" height="24" src="docs/assets/logo.svg"> Create Pull Request
+[![CI](https://github.com/peter-evans/create-pull-request/workflows/CI/badge.svg)](https://github.com/peter-evans/create-pull-request/actions?query=workflow%3ACI)
+[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Create%20Pull%20Request-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=github)](https://github.com/marketplace/actions/create-pull-request)
 
 A GitHub action to create a pull request for changes to your repository in the actions workspace.
 
@@ -9,130 +10,257 @@ The changes will be automatically committed to a new branch and a pull request c
 
 Create Pull Request action will:
 
-1. Check for repository changes in the Actions workspace. This includes untracked (new) files as well as modified files.
+1. Check for repository changes in the Actions workspace. This includes:
+   - untracked (new) files
+   - tracked (modified) files
+   - commits made during the workflow that have not been pushed
 2. Commit all changes to a new branch, or update an existing pull request branch.
-3. Create a pull request to merge the new branch into the currently active branch executing the workflow.
+3. Create a pull request to merge the new branch into the base&mdash;the branch checked out in the workflow.
+
+## Documentation
+
+- [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md)
+- [Examples](docs/examples.md)
+- [Updating to v4](docs/updating.md)
 
 ## Usage
 
-See [examples](examples.md) for detailed use cases.
-
 ```yml
+      - uses: actions/checkout@v3
+
+      # Make changes to pull request here
+
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+        uses: peter-evans/create-pull-request@v4
 ```
 
-**Note**: If you want pull requests created by this action to trigger an `on: pull_request` workflow then you must use a [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) instead of the default `GITHUB_TOKEN`.
-See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) for further details.
+You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format `@v4.x.x`
+
+### Workflow permissions
+
+For this action to work you must explicitly allow GitHub Actions to create pull requests.
+This setting can be found in a repository's settings under Actions > General > Workflow permissions.
+
+For repositories belonging to an organization, this setting can be managed by admins in organization settings under Actions > General > Workflow permissions.
 
 ### Action inputs
 
-These inputs are *all optional*. If not set, sensible default values will be used.
+All inputs are **optional**. If not set, sensible defaults will be used.
+
+**Note**: If you want pull requests created by this action to trigger an `on: push` or `on: pull_request` workflow then you cannot use the default `GITHUB_TOKEN`. See the [documentation here](docs/concepts-guidelines.md#triggering-further-workflow-runs) for workarounds.
 
 | Name | Description | Default |
 | --- | --- | --- |
-| `commit-message` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` |
-| `author-email` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>@users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. |
-| `author-name` | The name of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>, the GitHub user that initiated the event. |
-| `title` | The title of the pull request. | `Auto-generated by create-pull-request action` |
-| `body` | The body of the pull request. | `Auto-generated pull request by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action` |
-| `labels` | A comma separated list of labels. | none |
-| `assignees` | A comma separated list of assignees (GitHub usernames). | none |
-| `reviewers` | A comma separated list of reviewers (GitHub usernames) to request a review from. | none |
-| `team-reviewers` | A comma separated list of GitHub teams to request a review from. | none |
-| `milestone` | The number of the milestone to associate this pull request with. | none |
-| `branch` | The branch name. See **Branch naming** below for details. | `create-pull-request/patch` |
-| `base` | Overrides the base branch. **Use with caution!** | Defaults to the currently checked out branch. |
-| `branch-suffix` | The branch suffix type. Valid values are `short-commit-hash`, `timestamp`, `random` and `none`. See **Branch naming** below for details. | `short-commit-hash` |
+| `token` | `GITHUB_TOKEN` (permissions `contents: write` and `pull-requests: write`) or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` |
+| `path` | Relative path under `GITHUB_WORKSPACE` to the repository. | `GITHUB_WORKSPACE` |
+| `add-paths` | A comma or newline-separated list of file paths to commit. Paths should follow git's [pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) syntax. If no paths are specified, all new and modified files are added. See [Add specific paths](#add-specific-paths). | |
+| `commit-message` | The message to use when committing changes. | `[create-pull-request] automated change` |
+| `committer` | The committer name and email address in the format `Display Name <email@address.com>`. Defaults to the GitHub Actions bot user. | `GitHub <noreply@github.com>` |
+| `author` | The author name and email address in the format `Display Name <email@address.com>`. Defaults to the user who triggered the workflow run. | `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>` |
+| `signoff` | Add [`Signed-off-by`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) line by the committer at the end of the commit log message. | `false` |
+| `branch` | The pull request branch name. | `create-pull-request/patch` |
+| `delete-branch` | Delete the `branch` when closing pull requests, and when undeleted after merging. Recommend `true`. | `false` |
+| `branch-suffix` | The branch suffix type when using the alternative branching strategy. Valid values are `random`, `timestamp` and `short-commit-hash`. See [Alternative strategy](#alternative-strategy---always-create-a-new-pull-request-branch) for details. | |
+| `base` | Sets the pull request base branch. | Defaults to the branch checked out in the workflow. |
+| `push-to-fork` | A fork of the checked-out parent repository to which the pull request branch will be pushed. e.g. `owner/repo-fork`. The pull request will be created to merge the fork's branch into the parent's base. See [push pull request branches to a fork](docs/concepts-guidelines.md#push-pull-request-branches-to-a-fork) for details. | |
+| `title` | The title of the pull request. | `Changes by create-pull-request action` |
+| `body` | The body of the pull request. | `Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action` |
+| `labels` | A comma or newline-separated list of labels. | |
+| `assignees` | A comma or newline-separated list of assignees (GitHub usernames). | |
+| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | |
+| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). If using a GitHub App, refer to [Authenticating with GitHub App generated tokens](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) for the proper permissions. | |
+| `milestone` | The number of the milestone to associate this pull request with. | |
+| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). It is not possible to change draft status after creation except through the web interface. | `false` |
 
-**Outputs**
+For self-hosted runners behind a corporate proxy set the `https_proxy` environment variable.
+```yml
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        env:
+          https_proxy: http://<proxy_address>:<port>
+```
 
-The pull request number is output as both an environment variable and a step output.
-Note that in order to read the step output the action step must have an id.
+### Action outputs
+
+The following outputs can be used by subsequent workflow steps.
+
+- `pull-request-number` - The pull request number.
+- `pull-request-url` - The URL of the pull request.
+- `pull-request-operation` - The pull request operation performed by the action, `created`, `updated` or `closed`.
+- `pull-request-head-sha` - The commit SHA of the pull request branch.
+
+Step outputs can be accessed as in the following example.
+Note that in order to read the step outputs the action step must have an id.
 
 ```yml
       - name: Create Pull Request
         id: cpr
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+        uses: peter-evans/create-pull-request@v4
       - name: Check outputs
+        if: ${{ steps.cpr.outputs.pull-request-number }}
         run: |
-          echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
 ```
 
-### Branch naming
+### Action behaviour
 
-For branch naming there are two strategies. Always create a new branch each time there are changes to be committed, OR, create a fixed-name pull request branch that will be updated with any new commits until it is merged or closed.
+The default behaviour of the action is to create a pull request that will be continually updated with new changes until it is merged or closed.
+Changes are committed and pushed to a fixed-name branch, the name of which can be configured with the `branch` input.
+Any subsequent changes will be committed to the *same* branch and reflected in the open pull request.
 
-#### Strategy A - Always create a new pull request branch (default)
+How the action behaves:
 
-For this strategy there are three options to suffix the branch name.
-The branch name is defined by the input `branch` and defaults to `create-pull-request/patch`. The following options are values for `branch-suffix`.
+- If there are changes (i.e. a diff exists with the checked-out base branch), the changes will be pushed to a new `branch` and a pull request created.
+- If there are no changes (i.e. no diff exists with the checked-out base branch), no pull request will be created and the action exits silently.
+- If a pull request already exists it will be updated if necessary. Local changes in the Actions workspace, or changes on the base branch, can cause an update. If no update is required the action exits silently.
+- If a pull request exists and new changes on the base branch make the pull request unnecessary (i.e. there is no longer a diff between the pull request branch and the base), the pull request is automatically closed. Additionally, if `delete-branch` is set to `true` the `branch` will be deleted.
 
-- `short-commit-hash` (default) - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
+For further details about how the action works and usage guidelines, see [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md).
+
+#### Alternative strategy - Always create a new pull request branch
+
+For some use cases it may be desirable to always create a new unique branch each time there are changes to be committed.
+This strategy is *not recommended* because if not used carefully it could result in multiple pull requests being created unnecessarily. If in doubt, use the [default strategy](#action-behaviour) of creating an updating a fixed-name branch.
+
+To use this strategy, set input `branch-suffix` with one of the following options.
+
+- `random` - Commits will be made to a branch suffixed with a random alpha-numeric string. e.g. `create-pull-request/patch-6qj97jr`, `create-pull-request/patch-5jrjhvd`
 
 - `timestamp` - Commits will be made to a branch suffixed by a timestamp. e.g. `create-pull-request/patch-1569322532`, `create-pull-request/patch-1569322552`
 
-- `random` - Commits will be made to a branch suffixed with a random alpha-numeric string. This option should be used if multiple pull requests will be created during the execution of a workflow. e.g. `create-pull-request/patch-6qj97jr`, `create-pull-request/patch-5jrjhvd`
+- `short-commit-hash` - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
 
-#### Strategy B - Create and update a pull request branch
+### Controlling committed files
 
-To use this strategy, set `branch-suffix` to the value `none`. The input `branch` defaults to `create-pull-request/patch`. Commits will be made to this branch and a pull request created. Any subsequent changes will be committed to the *same* branch and reflected in the existing pull request.
+The action defaults to adding all new and modified files.
+If there are files that should not be included in the pull request, you can use the following methods to control the committed content.
 
-### Ignoring files
+#### Remove files
+
+The most straightforward way to handle unwanted files is simply to remove them in a step before the action runs.
+
+```yml
+      - run: |
+          rm -rf temp-dir
+          rm temp-file.txt
+```
+
+#### Ignore files
 
 If there are files or directories you want to ignore you can simply add them to a `.gitignore` file at the root of your repository. The action will respect this file.
 
-## Reference Example
+#### Add specific paths
 
-The following workflow is a reference example that sets all the main inputs.
-
-See [examples](examples.md) for more realistic use cases.
+You can control which files are committed with the `add-paths` input.
+Paths should follow git's [pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) syntax.
+All file changes that do not match one of the paths will be discarded.
+
+```yml
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          add-paths: |
+            *.java
+            docs/*.md
+```
+
+#### Create your own commits
+
+As well as relying on the action to handle uncommitted changes, you can additionally make your own commits before the action runs.
+Note that the repository must be checked out on a branch with a remote, it won't work for [events which checkout a commit](docs/concepts-guidelines.md#events-which-checkout-a-commit).
+
+```yml
+    steps:
+      - uses: actions/checkout@v3
+      - name: Create commits
+        run: |
+          git config user.name 'Peter Evans'
+          git config user.email 'peter-evans@users.noreply.github.com'
+          date +%s > report.txt
+          git commit -am "Modify tracked file during workflow"
+          date +%s > new-report.txt
+          git add -A
+          git commit -m "Add untracked file during workflow"
+      - name: Uncommitted change
+        run: date +%s > report.txt
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+```
+
+### Create a project card
+
+To create a project card for the pull request, pass the `pull-request-number` step output to [create-or-update-project-card](https://github.com/peter-evans/create-or-update-project-card) action.
+
+```yml
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v4
+
+      - name: Create or Update Project Card
+        if: ${{ steps.cpr.outputs.pull-request-number }}
+        uses: peter-evans/create-or-update-project-card@v2
+        with:
+          project-name: My project
+          column-name: My column
+          issue-number: ${{ steps.cpr.outputs.pull-request-number }}
+```
+
+### Auto-merge
+
+Auto-merge can be enabled on a pull request allowing it to be automatically merged once requirements have been satisfied.
+See [enable-pull-request-automerge](https://github.com/peter-evans/enable-pull-request-automerge) action for usage details.
+
+## Reference Example
+
+The following workflow sets many of the action's inputs for reference purposes.
+Check the [defaults](#action-inputs) to avoid setting inputs unnecessarily.
+
+See [examples](docs/examples.md) for more realistic use cases.
 
 ```yml
-name: Create Pull Request
-on: push
 jobs:
   createPullRequest:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - name: Create report file
+      - uses: actions/checkout@v3
+
+      - name: Make changes to pull request
         run: date +%s > report.txt
+
       - name: Create Pull Request
         id: cpr
-        uses: peter-evans/create-pull-request@v1.7.1
+        uses: peter-evans/create-pull-request@v4
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: Add report file
-          author-email: peter-evans@users.noreply.github.com
-          author-name: Peter Evans
-          title: '[Example] Add report file'
+          token: ${{ secrets.PAT }}
+          commit-message: Update report
+          committer: GitHub <noreply@github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          signoff: false
+          branch: example-patches
+          delete-branch: true
+          title: '[Example] Update report'
           body: |
-            New report
-            - Contains *today's* date
+            Update report
+            - Updated with *today's* date
             - Auto-generated by [create-pull-request][1]
 
             [1]: https://github.com/peter-evans/create-pull-request
-          labels: report, automated pr
+          labels: |
+            report
+            automated pr
           assignees: peter-evans
           reviewers: peter-evans
+          team-reviewers: |
+            owners
+            maintainers
           milestone: 1
-          branch: example-patches
-          branch-suffix: short-commit-hash
-      - name: Check outputs
-        run: |
-          echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
+          draft: false
 ```
 
-This reference configuration will create pull requests that look like this:
+An example based on the above reference configuration creates pull requests that look like this:
 
-![Pull Request Example](assets/pull-request-example.png)
+![Pull Request Example](docs/assets/pull-request-example.png)
 
 ## License
 

__test__/entrypoint.sh

@@ -0,0 +1,41 @@
+#!/bin/sh -l
+set -euo pipefail
+
+# Save the working directory
+WORKINGDIR=$PWD
+
+# Create and serve a remote repo
+mkdir -p /git/remote
+git config --global init.defaultBranch main
+git init --bare /git/remote/test-base.git
+git daemon --verbose --enable=receive-pack --base-path=/git/remote --export-all /git/remote &>/dev/null &
+
+# Give the daemon time to start
+sleep 2
+
+# Create a local clone and make an initial commit
+mkdir -p /git/local
+git clone git://127.0.0.1/test-base.git /git/local/test-base
+cd /git/local/test-base
+git config --global user.email "you@example.com"
+git config --global user.name "Your Name"
+echo "#test-base" > README.md
+git add .
+git commit -m "initial commit"
+git push -u
+git log -1 --pretty=oneline
+git config --global --unset user.email
+git config --global --unset user.name
+git config -l
+
+# Clone a server-side fork of the base repo
+cd $WORKINGDIR
+git clone --mirror git://127.0.0.1/test-base.git /git/remote/test-fork.git
+cd /git/remote/test-fork.git
+git log -1 --pretty=oneline
+
+# Restore the working directory
+cd $WORKINGDIR
+
+# Execute integration tests
+jest int --runInBand

__test__/git-auth-helper.int.test.ts

@@ -0,0 +1,49 @@
+import {GitCommandManager} from '../lib/git-command-manager'
+import {GitAuthHelper} from '../lib/git-auth-helper'
+
+const REPO_PATH = '/git/local/test-base'
+
+const extraheaderConfigKey = 'http.https://github.com/.extraheader'
+
+describe('git-auth-helper tests', () => {
+  let git: GitCommandManager
+  let gitAuthHelper: GitAuthHelper
+
+  beforeAll(async () => {
+    git = await GitCommandManager.create(REPO_PATH)
+    gitAuthHelper = new GitAuthHelper(git)
+  })
+
+  it('tests save and restore with no persisted auth', async () => {
+    await gitAuthHelper.savePersistedAuth()
+    await gitAuthHelper.restorePersistedAuth()
+  })
+
+  it('tests configure and removal of auth', async () => {
+    await gitAuthHelper.configureToken('github-token')
+    expect(await git.configExists(extraheaderConfigKey)).toBeTruthy()
+    expect(await git.getConfigValue(extraheaderConfigKey)).toEqual(
+      'AUTHORIZATION: basic eC1hY2Nlc3MtdG9rZW46Z2l0aHViLXRva2Vu'
+    )
+
+    await gitAuthHelper.removeAuth()
+    expect(await git.configExists(extraheaderConfigKey)).toBeFalsy()
+  })
+
+  it('tests save and restore of persisted auth', async () => {
+    const extraheaderConfigValue = 'AUTHORIZATION: basic ***persisted-auth***'
+    await git.config(extraheaderConfigKey, extraheaderConfigValue)
+
+    await gitAuthHelper.savePersistedAuth()
+
+    const exists = await git.configExists(extraheaderConfigKey)
+    expect(exists).toBeFalsy()
+
+    await gitAuthHelper.restorePersistedAuth()
+
+    const configValue = await git.getConfigValue(extraheaderConfigKey)
+    expect(configValue).toEqual(extraheaderConfigValue)
+
+    await gitAuthHelper.removeAuth()
+  })
+})

__test__/integration-tests.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+IMAGE="cpr-integration-tests:latest"
+ARG1=${1:-}
+
+if [[ "$(docker images -q $IMAGE 2> /dev/null)" == "" || $ARG1 == "build" ]]; then
+    echo "Building Docker image $IMAGE ..."
+
+    cat > Dockerfile << EOF
+FROM node:16-alpine
+RUN apk --no-cache add git git-daemon
+RUN npm install jest jest-environment-jsdom --global
+WORKDIR /cpr
+COPY __test__/entrypoint.sh /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]
+EOF
+
+    docker build --no-cache -t $IMAGE .
+    rm Dockerfile
+fi
+
+docker run -v $PWD:/cpr $IMAGE

__test__/utils.unit.test.ts

@@ -0,0 +1,165 @@
+import * as path from 'path'
+import * as utils from '../lib/utils'
+
+const originalGitHubWorkspace = process.env['GITHUB_WORKSPACE']
+
+describe('utils tests', () => {
+  beforeAll(() => {
+    // GitHub workspace
+    process.env['GITHUB_WORKSPACE'] = __dirname
+  })
+
+  afterAll(() => {
+    // Restore GitHub workspace
+    delete process.env['GITHUB_WORKSPACE']
+    if (originalGitHubWorkspace) {
+      process.env['GITHUB_WORKSPACE'] = originalGitHubWorkspace
+    }
+  })
+
+  test('getStringAsArray splits string input by newlines and commas', async () => {
+    const array = utils.getStringAsArray('1, 2, 3\n4, 5, 6')
+    expect(array.length).toEqual(6)
+
+    const array2 = utils.getStringAsArray('')
+    expect(array2.length).toEqual(0)
+  })
+
+  test('getRepoPath successfully returns the path to the repository', async () => {
+    expect(utils.getRepoPath()).toEqual(process.env['GITHUB_WORKSPACE'])
+    expect(utils.getRepoPath('foo')).toEqual(
+      path.resolve(process.env['GITHUB_WORKSPACE'] || '', 'foo')
+    )
+  })
+
+  test('getRemoteDetail successfully parses remote URLs', async () => {
+    const remote1 = utils.getRemoteDetail(
+      'https://github.com/peter-evans/create-pull-request'
+    )
+    expect(remote1.protocol).toEqual('HTTPS')
+    expect(remote1.repository).toEqual('peter-evans/create-pull-request')
+
+    const remote2 = utils.getRemoteDetail(
+      'https://xxx:x-oauth-basic@github.com/peter-evans/create-pull-request'
+    )
+    expect(remote2.protocol).toEqual('HTTPS')
+    expect(remote2.repository).toEqual('peter-evans/create-pull-request')
+
+    const remote3 = utils.getRemoteDetail(
+      'git@github.com:peter-evans/create-pull-request.git'
+    )
+    expect(remote3.protocol).toEqual('SSH')
+    expect(remote3.repository).toEqual('peter-evans/create-pull-request')
+
+    const remote4 = utils.getRemoteDetail(
+      'https://github.com/peter-evans/create-pull-request.git'
+    )
+    expect(remote4.protocol).toEqual('HTTPS')
+    expect(remote4.repository).toEqual('peter-evans/create-pull-request')
+
+    const remote5 = utils.getRemoteDetail(
+      'https://github.com/peter-evans/ungit'
+    )
+    expect(remote5.protocol).toEqual('HTTPS')
+    expect(remote5.repository).toEqual('peter-evans/ungit')
+
+    const remote6 = utils.getRemoteDetail(
+      'https://github.com/peter-evans/ungit.git'
+    )
+    expect(remote6.protocol).toEqual('HTTPS')
+    expect(remote6.repository).toEqual('peter-evans/ungit')
+
+    const remote7 = utils.getRemoteDetail(
+      'git@github.com:peter-evans/ungit.git'
+    )
+    expect(remote7.protocol).toEqual('SSH')
+    expect(remote7.repository).toEqual('peter-evans/ungit')
+  })
+
+  test('getRemoteDetail fails to parse a remote URL', async () => {
+    const remoteUrl = 'https://github.com/peter-evans'
+    try {
+      utils.getRemoteDetail(remoteUrl)
+      // Fail the test if an error wasn't thrown
+      expect(true).toEqual(false)
+    } catch (e: any) {
+      expect(e.message).toEqual(
+        `The format of '${remoteUrl}' is not a valid GitHub repository URL`
+      )
+    }
+  })
+
+  test('getRemoteUrl successfully returns remote URLs', async () => {
+    const url1 = utils.getRemoteUrl(
+      'HTTPS',
+      'github.com',
+      'peter-evans/create-pull-request'
+    )
+    expect(url1).toEqual('https://github.com/peter-evans/create-pull-request')
+
+    const url2 = utils.getRemoteUrl(
+      'SSH',
+      'github.com',
+      'peter-evans/create-pull-request'
+    )
+    expect(url2).toEqual('git@github.com:peter-evans/create-pull-request.git')
+
+    const url3 = utils.getRemoteUrl(
+      'HTTPS',
+      'mygithubserver.com',
+      'peter-evans/create-pull-request'
+    )
+    expect(url3).toEqual(
+      'https://mygithubserver.com/peter-evans/create-pull-request'
+    )
+  })
+
+  test('secondsSinceEpoch returns the number of seconds since the Epoch', async () => {
+    const seconds = `${utils.secondsSinceEpoch()}`
+    expect(seconds.length).toEqual(10)
+  })
+
+  test('randomString returns strings of length 7', async () => {
+    for (let i = 0; i < 1000; i++) {
+      expect(utils.randomString().length).toEqual(7)
+    }
+  })
+
+  test('parseDisplayNameEmail successfully parses display name email formats', async () => {
+    const parsed1 = utils.parseDisplayNameEmail('abc def <abc@def.com>')
+    expect(parsed1.name).toEqual('abc def')
+    expect(parsed1.email).toEqual('abc@def.com')
+
+    const parsed2 = utils.parseDisplayNameEmail(
+      'github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>'
+    )
+    expect(parsed2.name).toEqual('github-actions[bot]')
+    expect(parsed2.email).toEqual(
+      '41898282+github-actions[bot]@users.noreply.github.com'
+    )
+  })
+
+  test('parseDisplayNameEmail fails to parse display name email formats', async () => {
+    const displayNameEmail1 = 'abc@def.com'
+    try {
+      utils.parseDisplayNameEmail(displayNameEmail1)
+      // Fail the test if an error wasn't thrown
+      expect(true).toEqual(false)
+    } catch (e: any) {
+      expect(e.message).toEqual(
+        `The format of '${displayNameEmail1}' is not a valid email address with display name`
+      )
+    }
+
+    const displayNameEmail2 = ' < >'
+    try {
+      utils.parseDisplayNameEmail(displayNameEmail2)
+      // Fail the test if an error wasn't thrown
+      expect(true).toEqual(false)
+    } catch (e: any) {
+      expect(e.message).toEqual(
+        `The format of '${displayNameEmail2}' is not a valid email address with display name`
+      )
+    }
+  })
+})

action.yml

@@ -2,40 +2,85 @@ name: 'Create Pull Request'
 description: 'Creates a pull request for changes to your repository in the actions workspace'
 inputs:
   token:
-    description: 'The GitHub authentication token'
-    required: true
+    description: 'GITHUB_TOKEN or a `repo` scoped Personal Access Token (PAT)'
+    default: ${{ github.token }}
+  path:
+    description: >
+      Relative path under $GITHUB_WORKSPACE to the repository.
+      Defaults to $GITHUB_WORKSPACE.
+  add-paths:
+    description: >
+      A comma or newline-separated list of file paths to commit.
+      Paths should follow git's pathspec syntax.
+      Defaults to adding all new and modified files.
   commit-message:
     description: 'The message to use when committing changes.'
-  author-email:
-    description: 'The email address of the commit author.'
-  author-name:
-    description: 'The name of the commit author.'
-  title:
-    description: 'The title of the pull request.'
-  body:
-    description: 'The body of the pull request.'
-  labels:
-    description: 'A comma separated list of labels.'
-  assignees:
-    description: 'A comma separated list of assignees (GitHub usernames).'
-  reviewers:
-    description: 'A comma separated list of reviewers (GitHub usernames) to request a review from.'
-  team-reviewers:
-    description: 'A comma separated list of GitHub teams to request a review from.'
-  milestone:
-    description: 'The number of the milestone to associate this pull request with.'
+    default: '[create-pull-request] automated change'
+  committer:
+    description: >
+      The committer name and email address in the format `Display Name <email@address.com>`.
+      Defaults to the GitHub Actions bot user.
+    default: 'GitHub <noreply@github.com>'
+  author:
+    description: >
+      The author name and email address in the format `Display Name <email@address.com>`.
+      Defaults to the user who triggered the workflow run.
+    default: '${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>'
+  signoff:
+    description: 'Add `Signed-off-by` line by the committer at the end of the commit log message.'
+    default: false
   branch:
     description: 'The pull request branch name.'
-  base:
-    description: 'Overrides the base branch.'
+    default: 'create-pull-request/patch'
+  delete-branch:
+    description: >
+      Delete the `branch` when closing pull requests, and when undeleted after merging.
+      Recommend `true`.
+    default: false
   branch-suffix:
-    description: 'The branch suffix type.'
+    description: 'The branch suffix type when using the alternative branching strategy.'
+  base:
+    description: >
+      The pull request base branch.
+      Defaults to the branch checked out in the workflow.
+  push-to-fork:
+    description: >
+      A fork of the checked out parent repository to which the pull request branch will be pushed.
+      e.g. `owner/repo-fork`.
+      The pull request will be created to merge the fork's branch into the parent's base.
+  title:
+    description: 'The title of the pull request.'
+    default: 'Changes by create-pull-request action'
+  body:
+    description: 'The body of the pull request.'
+    default: 'Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action'
+  labels:
+    description: 'A comma or newline separated list of labels.'
+  assignees:
+    description: 'A comma or newline separated list of assignees (GitHub usernames).'
+  reviewers:
+    description: 'A comma or newline separated list of reviewers (GitHub usernames) to request a review from.'
+  team-reviewers:
+    description: >
+      A comma or newline separated list of GitHub teams to request a review from.
+      Note that a `repo` scoped Personal Access Token (PAT) may be required.
+  milestone:
+    description: 'The number of the milestone to associate the pull request with.'
+  draft:
+    description: 'Create a draft pull request. It is not possible to change draft status after creation except through the web interface'
+    default: false
 outputs:
-  pr_number:
+  pull-request-number:
     description: 'The pull request number'
+  pull-request-url:
+    description: 'The URL of the pull request.'
+  pull-request-operation:
+    description: 'The pull request operation performed by the action, `created`, `updated` or `closed`.'
+  pull-request-head-sha:
+    description: 'The commit SHA of the pull request branch.'
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'dist/index.js'
 branding:
-  icon: 'git-pull-request'  
+  icon: 'git-pull-request'
   color: 'gray-dark'

dist/events.js

@@ -0,0 +1,977 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+// Modified by the vm2 team to make this a standalone module to be loaded into the sandbox.
+
+'use strict';
+
+const host = fromhost;
+
+const {
+	Boolean,
+  Error,
+	String,
+	Symbol
+} = globalThis;
+
+const ReflectApply = Reflect.apply;
+const ReflectOwnKeys = Reflect.ownKeys;
+
+const ErrorCaptureStackTrace = Error.captureStackTrace;
+
+const NumberIsNaN = Number.isNaN;
+
+const ObjectCreate = Object.create;
+const ObjectDefineProperty = Object.defineProperty;
+const ObjectDefineProperties = Object.defineProperties;
+const ObjectGetPrototypeOf = Object.getPrototypeOf;
+
+const SymbolFor = Symbol.for;
+
+function uncurryThis(func) {
+	return (thiz, ...args) => ReflectApply(func, thiz, args);
+}
+
+const ArrayPrototypeIndexOf = uncurryThis(Array.prototype.indexOf);
+const ArrayPrototypeJoin = uncurryThis(Array.prototype.join);
+const ArrayPrototypeSlice = uncurryThis(Array.prototype.slice);
+const ArrayPrototypeSplice = uncurryThis(Array.prototype.splice);
+const ArrayPrototypeUnshift = uncurryThis(Array.prototype.unshift);
+
+const kRejection = SymbolFor('nodejs.rejection');
+
+function inspect(obj) {
+	return typeof obj === 'symbol' ? obj.toString() : `${obj}`;
+}
+
+function spliceOne(list, index) {
+	for (; index + 1 < list.length; index++)
+		list[index] = list[index + 1];
+	list.pop();
+}
+
+function assert(what, message) {
+	if (!what) throw new Error(message);
+}
+
+function E(key, msg, Base) {
+	return function NodeError(...args) {
+	  const error = new Base();
+	  const message = ReflectApply(msg, error, args);
+	  ObjectDefineProperties(error, {
+		message: {
+		  value: message,
+		  enumerable: false,
+		  writable: true,
+		  configurable: true,
+		},
+		toString: {
+		  value() {
+			return `${this.name} [${key}]: ${this.message}`;
+		  },
+		  enumerable: false,
+		  writable: true,
+		  configurable: true,
+		},
+	  });
+	  error.code = key;
+	  return error;
+	};
+}
+
+
+const ERR_INVALID_ARG_TYPE = E('ERR_INVALID_ARG_TYPE',
+  (name, expected, actual) => {
+    assert(typeof name === 'string', "'name' must be a string");
+    if (!ArrayIsArray(expected)) {
+      expected = [expected];
+    }
+
+    let msg = 'The ';
+    if (StringPrototypeEndsWith(name, ' argument')) {
+      // For cases like 'first argument'
+      msg += `${name} `;
+    } else {
+      const type = StringPrototypeIncludes(name, '.') ? 'property' : 'argument';
+      msg += `"${name}" ${type} `;
+    }
+    msg += 'must be ';
+
+    const types = [];
+    const instances = [];
+    const other = [];
+
+    for (const value of expected) {
+      assert(typeof value === 'string',
+             'All expected entries have to be of type string');
+      if (ArrayPrototypeIncludes(kTypes, value)) {
+        ArrayPrototypePush(types, StringPrototypeToLowerCase(value));
+      } else if (RegExpPrototypeTest(classRegExp, value)) {
+        ArrayPrototypePush(instances, value);
+      } else {
+        assert(value !== 'object',
+               'The value "object" should be written as "Object"');
+        ArrayPrototypePush(other, value);
+      }
+    }
+
+    // Special handle `object` in case other instances are allowed to outline
+    // the differences between each other.
+    if (instances.length > 0) {
+      const pos = ArrayPrototypeIndexOf(types, 'object');
+      if (pos !== -1) {
+        ArrayPrototypeSplice(types, pos, 1);
+        ArrayPrototypePush(instances, 'Object');
+      }
+    }
+
+    if (types.length > 0) {
+      if (types.length > 2) {
+        const last = ArrayPrototypePop(types);
+        msg += `one of type ${ArrayPrototypeJoin(types, ', ')}, or ${last}`;
+      } else if (types.length === 2) {
+        msg += `one of type ${types[0]} or ${types[1]}`;
+      } else {
+        msg += `of type ${types[0]}`;
+      }
+      if (instances.length > 0 || other.length > 0)
+        msg += ' or ';
+    }
+
+    if (instances.length > 0) {
+      if (instances.length > 2) {
+        const last = ArrayPrototypePop(instances);
+        msg +=
+          `an instance of ${ArrayPrototypeJoin(instances, ', ')}, or ${last}`;
+      } else {
+        msg += `an instance of ${instances[0]}`;
+        if (instances.length === 2) {
+          msg += ` or ${instances[1]}`;
+        }
+      }
+      if (other.length > 0)
+        msg += ' or ';
+    }
+
+    if (other.length > 0) {
+      if (other.length > 2) {
+        const last = ArrayPrototypePop(other);
+        msg += `one of ${ArrayPrototypeJoin(other, ', ')}, or ${last}`;
+      } else if (other.length === 2) {
+        msg += `one of ${other[0]} or ${other[1]}`;
+      } else {
+        if (StringPrototypeToLowerCase(other[0]) !== other[0])
+          msg += 'an ';
+        msg += `${other[0]}`;
+      }
+    }
+
+    if (actual == null) {
+      msg += `. Received ${actual}`;
+    } else if (typeof actual === 'function' && actual.name) {
+      msg += `. Received function ${actual.name}`;
+    } else if (typeof actual === 'object') {
+      if (actual.constructor && actual.constructor.name) {
+        msg += `. Received an instance of ${actual.constructor.name}`;
+      } else {
+        const inspected = inspect(actual, { depth: -1 });
+        msg += `. Received ${inspected}`;
+      }
+    } else {
+      let inspected = inspect(actual, { colors: false });
+      if (inspected.length > 25)
+        inspected = `${StringPrototypeSlice(inspected, 0, 25)}...`;
+      msg += `. Received type ${typeof actual} (${inspected})`;
+    }
+    return msg;
+  }, TypeError);
+
+const ERR_INVALID_THIS = E('ERR_INVALID_THIS', s => `Value of "this" must be of type ${s}`, TypeError);
+
+const ERR_OUT_OF_RANGE = E('ERR_OUT_OF_RANGE',
+  (str, range, input, replaceDefaultBoolean = false) => {
+    assert(range, 'Missing "range" argument');
+    let msg = replaceDefaultBoolean ? str :
+      `The value of "${str}" is out of range.`;
+    const received = inspect(input);
+    msg += ` It must be ${range}. Received ${received}`;
+    return msg;
+  }, RangeError);
+
+const ERR_UNHANDLED_ERROR = E('ERR_UNHANDLED_ERROR',
+  err => {
+    const msg = 'Unhandled error.';
+    if (err === undefined) return msg;
+    return `${msg} (${err})`;
+  }, Error);
+
+function validateBoolean(value, name) {
+  if (typeof value !== 'boolean')
+    throw new ERR_INVALID_ARG_TYPE(name, 'boolean', value);
+}
+
+function validateFunction(value, name) {
+  if (typeof value !== 'function')
+    throw new ERR_INVALID_ARG_TYPE(name, 'Function', value);
+}
+
+function validateString(value, name) {
+  if (typeof value !== 'string')
+    throw new ERR_INVALID_ARG_TYPE(name, 'string', value);
+}
+
+function nc(cond, e) {
+	return cond === undefined || cond === null ? e : cond;
+}
+
+function oc(base, key) {
+	return base === undefined || base === null ? undefined : base[key];
+}
+
+const kCapture = Symbol('kCapture');
+const kErrorMonitor = host.kErrorMonitor || Symbol('events.errorMonitor');
+const kMaxEventTargetListeners = Symbol('events.maxEventTargetListeners');
+const kMaxEventTargetListenersWarned =
+  Symbol('events.maxEventTargetListenersWarned');
+
+const kIsEventTarget = SymbolFor('nodejs.event_target');
+
+function isEventTarget(obj) {
+	return oc(oc(obj, 'constructor'), kIsEventTarget);
+}
+
+/**
+ * Creates a new `EventEmitter` instance.
+ * @param {{ captureRejections?: boolean; }} [opts]
+ * @constructs {EventEmitter}
+ */
+function EventEmitter(opts) {
+  EventEmitter.init.call(this, opts);
+}
+module.exports = EventEmitter;
+if (host.once) module.exports.once = host.once;
+if (host.on) module.exports.on = host.on;
+if (host.getEventListeners) module.exports.getEventListeners = host.getEventListeners;
+// Backwards-compat with node 0.10.x
+EventEmitter.EventEmitter = EventEmitter;
+
+EventEmitter.usingDomains = false;
+
+EventEmitter.captureRejectionSymbol = kRejection;
+ObjectDefineProperty(EventEmitter, 'captureRejections', {
+  get() {
+    return EventEmitter.prototype[kCapture];
+  },
+  set(value) {
+    validateBoolean(value, 'EventEmitter.captureRejections');
+
+    EventEmitter.prototype[kCapture] = value;
+  },
+  enumerable: true
+});
+
+if (host.EventEmitterReferencingAsyncResource) {
+	const kAsyncResource = Symbol('kAsyncResource');
+	const EventEmitterReferencingAsyncResource = host.EventEmitterReferencingAsyncResource;
+
+	class EventEmitterAsyncResource extends EventEmitter {
+		/**
+		 * @param {{
+		 *   name?: string,
+		 *   triggerAsyncId?: number,
+		 *   requireManualDestroy?: boolean,
+		 * }} [options]
+		 */
+		constructor(options = undefined) {
+			let name;
+			if (typeof options === 'string') {
+				name = options;
+				options = undefined;
+			} else {
+				if (new.target === EventEmitterAsyncResource) {
+					validateString(oc(options, 'name'), 'options.name');
+				}
+				name = oc(options, 'name') || new.target.name;
+			}
+			super(options);
+
+			this[kAsyncResource] =
+				new EventEmitterReferencingAsyncResource(this, name, options);
+		}
+
+		/**
+		 * @param {symbol,string} event
+		 * @param  {...any} args
+		 * @returns {boolean}
+		 */
+		emit(event, ...args) {
+			if (this[kAsyncResource] === undefined)
+				throw new ERR_INVALID_THIS('EventEmitterAsyncResource');
+			const { asyncResource } = this;
+			ArrayPrototypeUnshift(args, super.emit, this, event);
+			return ReflectApply(asyncResource.runInAsyncScope, asyncResource,
+													args);
+		}
+
+		/**
+		 * @returns {void}
+		 */
+		emitDestroy() {
+			if (this[kAsyncResource] === undefined)
+				throw new ERR_INVALID_THIS('EventEmitterAsyncResource');
+			this.asyncResource.emitDestroy();
+		}
+
+		/**
+		 * @type {number}
+		 */
+		get asyncId() {
+			if (this[kAsyncResource] === undefined)
+				throw new ERR_INVALID_THIS('EventEmitterAsyncResource');
+			return this.asyncResource.asyncId();
+		}
+
+		/**
+		 * @type {number}
+		 */
+		get triggerAsyncId() {
+			if (this[kAsyncResource] === undefined)
+				throw new ERR_INVALID_THIS('EventEmitterAsyncResource');
+			return this.asyncResource.triggerAsyncId();
+		}
+
+		/**
+		 * @type {EventEmitterReferencingAsyncResource}
+		 */
+		get asyncResource() {
+			if (this[kAsyncResource] === undefined)
+				throw new ERR_INVALID_THIS('EventEmitterAsyncResource');
+			return this[kAsyncResource];
+		}
+	}
+	EventEmitter.EventEmitterAsyncResource = EventEmitterAsyncResource;
+}
+
+EventEmitter.errorMonitor = kErrorMonitor;
+
+// The default for captureRejections is false
+ObjectDefineProperty(EventEmitter.prototype, kCapture, {
+  value: false,
+  writable: true,
+  enumerable: false
+});
+
+EventEmitter.prototype._events = undefined;
+EventEmitter.prototype._eventsCount = 0;
+EventEmitter.prototype._maxListeners = undefined;
+
+// By default EventEmitters will print a warning if more than 10 listeners are
+// added to it. This is a useful default which helps finding memory leaks.
+let defaultMaxListeners = 10;
+
+function checkListener(listener) {
+  validateFunction(listener, 'listener');
+}
+
+ObjectDefineProperty(EventEmitter, 'defaultMaxListeners', {
+  enumerable: true,
+  get: function() {
+    return defaultMaxListeners;
+  },
+  set: function(arg) {
+    if (typeof arg !== 'number' || arg < 0 || NumberIsNaN(arg)) {
+      throw new ERR_OUT_OF_RANGE('defaultMaxListeners',
+                                 'a non-negative number',
+                                 arg);
+    }
+    defaultMaxListeners = arg;
+  }
+});
+
+ObjectDefineProperties(EventEmitter, {
+  kMaxEventTargetListeners: {
+    value: kMaxEventTargetListeners,
+    enumerable: false,
+    configurable: false,
+    writable: false,
+  },
+  kMaxEventTargetListenersWarned: {
+    value: kMaxEventTargetListenersWarned,
+    enumerable: false,
+    configurable: false,
+    writable: false,
+  }
+});
+
+/**
+ * Sets the max listeners.
+ * @param {number} n
+ * @param {EventTarget[] | EventEmitter[]} [eventTargets]
+ * @returns {void}
+ */
+EventEmitter.setMaxListeners =
+  function(n = defaultMaxListeners, ...eventTargets) {
+    if (typeof n !== 'number' || n < 0 || NumberIsNaN(n))
+      throw new ERR_OUT_OF_RANGE('n', 'a non-negative number', n);
+    if (eventTargets.length === 0) {
+      defaultMaxListeners = n;
+    } else {
+      for (let i = 0; i < eventTargets.length; i++) {
+        const target = eventTargets[i];
+        if (isEventTarget(target)) {
+          target[kMaxEventTargetListeners] = n;
+          target[kMaxEventTargetListenersWarned] = false;
+        } else if (typeof target.setMaxListeners === 'function') {
+          target.setMaxListeners(n);
+        } else {
+          throw new ERR_INVALID_ARG_TYPE(
+            'eventTargets',
+            ['EventEmitter', 'EventTarget'],
+            target);
+        }
+      }
+    }
+  };
+
+// If you're updating this function definition, please also update any
+// re-definitions, such as the one in the Domain module (lib/domain.js).
+EventEmitter.init = function(opts) {
+
+  if (this._events === undefined ||
+      this._events === ObjectGetPrototypeOf(this)._events) {
+    this._events = ObjectCreate(null);
+    this._eventsCount = 0;
+  }
+
+  this._maxListeners = this._maxListeners || undefined;
+
+
+  if (oc(opts, 'captureRejections')) {
+    validateBoolean(opts.captureRejections, 'options.captureRejections');
+    this[kCapture] = Boolean(opts.captureRejections);
+  } else {
+    // Assigning the kCapture property directly saves an expensive
+    // prototype lookup in a very sensitive hot path.
+    this[kCapture] = EventEmitter.prototype[kCapture];
+  }
+};
+
+function addCatch(that, promise, type, args) {
+  if (!that[kCapture]) {
+    return;
+  }
+
+  // Handle Promises/A+ spec, then could be a getter
+  // that throws on second use.
+  try {
+    const then = promise.then;
+
+    if (typeof then === 'function') {
+      then.call(promise, undefined, function(err) {
+        // The callback is called with nextTick to avoid a follow-up
+        // rejection from this promise.
+        process.nextTick(emitUnhandledRejectionOrErr, that, err, type, args);
+      });
+    }
+  } catch (err) {
+    that.emit('error', err);
+  }
+}
+
+function emitUnhandledRejectionOrErr(ee, err, type, args) {
+  if (typeof ee[kRejection] === 'function') {
+    ee[kRejection](err, type, ...args);
+  } else {
+    // We have to disable the capture rejections mechanism, otherwise
+    // we might end up in an infinite loop.
+    const prev = ee[kCapture];
+
+    // If the error handler throws, it is not catchable and it
+    // will end up in 'uncaughtException'. We restore the previous
+    // value of kCapture in case the uncaughtException is present
+    // and the exception is handled.
+    try {
+      ee[kCapture] = false;
+      ee.emit('error', err);
+    } finally {
+      ee[kCapture] = prev;
+    }
+  }
+}
+
+/**
+ * Increases the max listeners of the event emitter.
+ * @param {number} n
+ * @returns {EventEmitter}
+ */
+EventEmitter.prototype.setMaxListeners = function setMaxListeners(n) {
+  if (typeof n !== 'number' || n < 0 || NumberIsNaN(n)) {
+    throw new ERR_OUT_OF_RANGE('n', 'a non-negative number', n);
+  }
+  this._maxListeners = n;
+  return this;
+};
+
+function _getMaxListeners(that) {
+  if (that._maxListeners === undefined)
+    return EventEmitter.defaultMaxListeners;
+  return that._maxListeners;
+}
+
+/**
+ * Returns the current max listener value for the event emitter.
+ * @returns {number}
+ */
+EventEmitter.prototype.getMaxListeners = function getMaxListeners() {
+  return _getMaxListeners(this);
+};
+
+/**
+ * Synchronously calls each of the listeners registered
+ * for the event.
+ * @param {string | symbol} type
+ * @param {...any} [args]
+ * @returns {boolean}
+ */
+EventEmitter.prototype.emit = function emit(type, ...args) {
+  let doError = (type === 'error');
+
+  const events = this._events;
+  if (events !== undefined) {
+    if (doError && events[kErrorMonitor] !== undefined)
+      this.emit(kErrorMonitor, ...args);
+    doError = (doError && events.error === undefined);
+  } else if (!doError)
+    return false;
+
+  // If there is no 'error' event listener then throw.
+  if (doError) {
+    let er;
+    if (args.length > 0)
+      er = args[0];
+    if (er instanceof Error) {
+      try {
+        const capture = {};
+        ErrorCaptureStackTrace(capture, EventEmitter.prototype.emit);
+      } catch (e) {}
+
+      // Note: The comments on the `throw` lines are intentional, they show
+      // up in Node's output if this results in an unhandled exception.
+      throw er; // Unhandled 'error' event
+    }
+
+    let stringifiedEr;
+    try {
+      stringifiedEr = inspect(er);
+    } catch (e) {
+      stringifiedEr = er;
+    }
+
+    // At least give some kind of context to the user
+    const err = new ERR_UNHANDLED_ERROR(stringifiedEr);
+    err.context = er;
+    throw err; // Unhandled 'error' event
+  }
+
+  const handler = events[type];
+
+  if (handler === undefined)
+    return false;
+
+  if (typeof handler === 'function') {
+    const result = handler.apply(this, args);
+
+    // We check if result is undefined first because that
+    // is the most common case so we do not pay any perf
+    // penalty
+    if (result !== undefined && result !== null) {
+      addCatch(this, result, type, args);
+    }
+  } else {
+    const len = handler.length;
+    const listeners = arrayClone(handler);
+    for (let i = 0; i < len; ++i) {
+      const result = listeners[i].apply(this, args);
+
+      // We check if result is undefined first because that
+      // is the most common case so we do not pay any perf
+      // penalty.
+      // This code is duplicated because extracting it away
+      // would make it non-inlineable.
+      if (result !== undefined && result !== null) {
+        addCatch(this, result, type, args);
+      }
+    }
+  }
+
+  return true;
+};
+
+function _addListener(target, type, listener, prepend) {
+  let m;
+  let events;
+  let existing;
+
+  checkListener(listener);
+
+  events = target._events;
+  if (events === undefined) {
+    events = target._events = ObjectCreate(null);
+    target._eventsCount = 0;
+  } else {
+    // To avoid recursion in the case that type === "newListener"! Before
+    // adding it to the listeners, first emit "newListener".
+    if (events.newListener !== undefined) {
+      target.emit('newListener', type,
+                  nc(listener.listener, listener));
+
+      // Re-assign `events` because a newListener handler could have caused the
+      // this._events to be assigned to a new object
+      events = target._events;
+    }
+    existing = events[type];
+  }
+
+  if (existing === undefined) {
+    // Optimize the case of one listener. Don't need the extra array object.
+    events[type] = listener;
+    ++target._eventsCount;
+  } else {
+    if (typeof existing === 'function') {
+      // Adding the second element, need to change to array.
+      existing = events[type] =
+        prepend ? [listener, existing] : [existing, listener];
+      // If we've already got an array, just append.
+    } else if (prepend) {
+      existing.unshift(listener);
+    } else {
+      existing.push(listener);
+    }
+
+    // Check for listener leak
+    m = _getMaxListeners(target);
+    if (m > 0 && existing.length > m && !existing.warned) {
+      existing.warned = true;
+      // No error code for this since it is a Warning
+      // eslint-disable-next-line no-restricted-syntax
+      const w = new Error('Possible EventEmitter memory leak detected. ' +
+                          `${existing.length} ${String(type)} listeners ` +
+                          `added to ${inspect(target, { depth: -1 })}. Use ` +
+                          'emitter.setMaxListeners() to increase limit');
+      w.name = 'MaxListenersExceededWarning';
+      w.emitter = target;
+      w.type = type;
+      w.count = existing.length;
+      process.emitWarning(w);
+    }
+  }
+
+  return target;
+}
+
+/**
+ * Adds a listener to the event emitter.
+ * @param {string | symbol} type
+ * @param {Function} listener
+ * @returns {EventEmitter}
+ */
+EventEmitter.prototype.addListener = function addListener(type, listener) {
+  return _addListener(this, type, listener, false);
+};
+
+EventEmitter.prototype.on = EventEmitter.prototype.addListener;
+
+/**
+ * Adds the `listener` function to the beginning of
+ * the listeners array.
+ * @param {string | symbol} type
+ * @param {Function} listener
+ * @returns {EventEmitter}
+ */
+EventEmitter.prototype.prependListener =
+    function prependListener(type, listener) {
+      return _addListener(this, type, listener, true);
+    };
+
+function onceWrapper() {
+  if (!this.fired) {
+    this.target.removeListener(this.type, this.wrapFn);
+    this.fired = true;
+    if (arguments.length === 0)
+      return this.listener.call(this.target);
+    return this.listener.apply(this.target, arguments);
+  }
+}
+
+function _onceWrap(target, type, listener) {
+  const state = { fired: false, wrapFn: undefined, target, type, listener };
+  const wrapped = onceWrapper.bind(state);
+  wrapped.listener = listener;
+  state.wrapFn = wrapped;
+  return wrapped;
+}
+
+/**
+ * Adds a one-time `listener` function to the event emitter.
+ * @param {string | symbol} type
+ * @param {Function} listener
+ * @returns {EventEmitter}
+ */
+EventEmitter.prototype.once = function once(type, listener) {
+  checkListener(listener);
+
+  this.on(type, _onceWrap(this, type, listener));
+  return this;
+};
+
+/**
+ * Adds a one-time `listener` function to the beginning of
+ * the listeners array.
+ * @param {string | symbol} type
+ * @param {Function} listener
+ * @returns {EventEmitter}
+ */
+EventEmitter.prototype.prependOnceListener =
+    function prependOnceListener(type, listener) {
+      checkListener(listener);
+
+      this.prependListener(type, _onceWrap(this, type, listener));
+      return this;
+    };
+
+
+/**
+ * Removes the specified `listener` from the listeners array.
+ * @param {string | symbol} type
+ * @param {Function} listener
+ * @returns {EventEmitter}
+ */
+EventEmitter.prototype.removeListener =
+    function removeListener(type, listener) {
+      checkListener(listener);
+
+      const events = this._events;
+      if (events === undefined)
+        return this;
+
+      const list = events[type];
+      if (list === undefined)
+        return this;
+
+      if (list === listener || list.listener === listener) {
+        if (--this._eventsCount === 0)
+          this._events = ObjectCreate(null);
+        else {
+          delete events[type];
+          if (events.removeListener)
+            this.emit('removeListener', type, list.listener || listener);
+        }
+      } else if (typeof list !== 'function') {
+        let position = -1;
+
+        for (let i = list.length - 1; i >= 0; i--) {
+          if (list[i] === listener || list[i].listener === listener) {
+            position = i;
+            break;
+          }
+        }
+
+        if (position < 0)
+          return this;
+
+        if (position === 0)
+          list.shift();
+        else {
+          spliceOne(list, position);
+        }
+
+        if (list.length === 1)
+          events[type] = list[0];
+
+        if (events.removeListener !== undefined)
+          this.emit('removeListener', type, listener);
+      }
+
+      return this;
+    };
+
+EventEmitter.prototype.off = EventEmitter.prototype.removeListener;
+
+/**
+ * Removes all listeners from the event emitter. (Only
+ * removes listeners for a specific event name if specified
+ * as `type`).
+ * @param {string | symbol} [type]
+ * @returns {EventEmitter}
+ */
+EventEmitter.prototype.removeAllListeners =
+    function removeAllListeners(type) {
+      const events = this._events;
+      if (events === undefined)
+        return this;
+
+      // Not listening for removeListener, no need to emit
+      if (events.removeListener === undefined) {
+        if (arguments.length === 0) {
+          this._events = ObjectCreate(null);
+          this._eventsCount = 0;
+        } else if (events[type] !== undefined) {
+          if (--this._eventsCount === 0)
+            this._events = ObjectCreate(null);
+          else
+            delete events[type];
+        }
+        return this;
+      }
+
+      // Emit removeListener for all listeners on all events
+      if (arguments.length === 0) {
+        for (const key of ReflectOwnKeys(events)) {
+          if (key === 'removeListener') continue;
+          this.removeAllListeners(key);
+        }
+        this.removeAllListeners('removeListener');
+        this._events = ObjectCreate(null);
+        this._eventsCount = 0;
+        return this;
+      }
+
+      const listeners = events[type];
+
+      if (typeof listeners === 'function') {
+        this.removeListener(type, listeners);
+      } else if (listeners !== undefined) {
+        // LIFO order
+        for (let i = listeners.length - 1; i >= 0; i--) {
+          this.removeListener(type, listeners[i]);
+        }
+      }
+
+      return this;
+    };
+
+function _listeners(target, type, unwrap) {
+  const events = target._events;
+
+  if (events === undefined)
+    return [];
+
+  const evlistener = events[type];
+  if (evlistener === undefined)
+    return [];
+
+  if (typeof evlistener === 'function')
+    return unwrap ? [evlistener.listener || evlistener] : [evlistener];
+
+  return unwrap ?
+    unwrapListeners(evlistener) : arrayClone(evlistener);
+}
+
+/**
+ * Returns a copy of the array of listeners for the event name
+ * specified as `type`.
+ * @param {string | symbol} type
+ * @returns {Function[]}
+ */
+EventEmitter.prototype.listeners = function listeners(type) {
+  return _listeners(this, type, true);
+};
+
+/**
+ * Returns a copy of the array of listeners and wrappers for
+ * the event name specified as `type`.
+ * @param {string | symbol} type
+ * @returns {Function[]}
+ */
+EventEmitter.prototype.rawListeners = function rawListeners(type) {
+  return _listeners(this, type, false);
+};
+
+/**
+ * Returns the number of listeners listening to the event name
+ * specified as `type`.
+ * @deprecated since v3.2.0
+ * @param {EventEmitter} emitter
+ * @param {string | symbol} type
+ * @returns {number}
+ */
+EventEmitter.listenerCount = function(emitter, type) {
+  if (typeof emitter.listenerCount === 'function') {
+    return emitter.listenerCount(type);
+  }
+  return emitter.listenerCount(type);
+};
+
+EventEmitter.prototype.listenerCount = listenerCount;
+
+/**
+ * Returns the number of listeners listening to event name
+ * specified as `type`.
+ * @param {string | symbol} type
+ * @returns {number}
+ */
+function listenerCount(type) {
+  const events = this._events;
+
+  if (events !== undefined) {
+    const evlistener = events[type];
+
+    if (typeof evlistener === 'function') {
+      return 1;
+    } else if (evlistener !== undefined) {
+      return evlistener.length;
+    }
+  }
+
+  return 0;
+}
+
+/**
+ * Returns an array listing the events for which
+ * the emitter has registered listeners.
+ * @returns {any[]}
+ */
+EventEmitter.prototype.eventNames = function eventNames() {
+  return this._eventsCount > 0 ? ReflectOwnKeys(this._events) : [];
+};
+
+function arrayClone(arr) {
+  // At least since V8 8.3, this implementation is faster than the previous
+  // which always used a simple for-loop
+  switch (arr.length) {
+    case 2: return [arr[0], arr[1]];
+    case 3: return [arr[0], arr[1], arr[2]];
+    case 4: return [arr[0], arr[1], arr[2], arr[3]];
+    case 5: return [arr[0], arr[1], arr[2], arr[3], arr[4]];
+    case 6: return [arr[0], arr[1], arr[2], arr[3], arr[4], arr[5]];
+  }
+  return ArrayPrototypeSlice(arr);
+}
+
+function unwrapListeners(arr) {
+  const ret = arrayClone(arr);
+  for (let i = 0; i < ret.length; ++i) {
+    const orig = ret[i].listener;
+    if (typeof orig === 'function')
+      ret[i] = orig;
+  }
+  return ret;
+}

dist/setup-node-sandbox.js

@@ -0,0 +1,469 @@
+/* global host, data, VMError */
+
+'use strict';
+
+const LocalError = Error;
+const LocalTypeError = TypeError;
+const LocalWeakMap = WeakMap;
+
+const {
+	apply: localReflectApply,
+	defineProperty: localReflectDefineProperty
+} = Reflect;
+
+const {
+	set: localWeakMapSet,
+	get: localWeakMapGet
+} = LocalWeakMap.prototype;
+
+const {
+	isArray: localArrayIsArray
+} = Array;
+
+function uncurryThis(func) {
+	return (thiz, ...args) => localReflectApply(func, thiz, args);
+}
+
+const localArrayPrototypeSlice = uncurryThis(Array.prototype.slice);
+const localArrayPrototypeIncludes = uncurryThis(Array.prototype.includes);
+const localArrayPrototypePush = uncurryThis(Array.prototype.push);
+const localArrayPrototypeIndexOf = uncurryThis(Array.prototype.indexOf);
+const localArrayPrototypeSplice = uncurryThis(Array.prototype.splice);
+const localStringPrototypeStartsWith = uncurryThis(String.prototype.startsWith);
+const localStringPrototypeSlice = uncurryThis(String.prototype.slice);
+const localStringPrototypeIndexOf = uncurryThis(String.prototype.indexOf);
+
+const {
+	argv: optionArgv,
+	env: optionEnv,
+	console: optionConsole,
+	vm,
+	resolver,
+	extensions
+} = data;
+
+function ensureSandboxArray(a) {
+	return localArrayPrototypeSlice(a);
+}
+
+const globalPaths = ensureSandboxArray(resolver.globalPaths);
+
+class Module {
+
+	constructor(id, path, parent) {
+		this.id = id;
+		this.filename = id;
+		this.path = path;
+		this.parent = parent;
+		this.loaded = false;
+		this.paths = path ? ensureSandboxArray(resolver.genLookupPaths(path)) : [];
+		this.children = [];
+		this.exports = {};
+	}
+
+	_updateChildren(child, isNew) {
+		const children = this.children;
+		if (children && (isNew || !localArrayPrototypeIncludes(children, child))) {
+			localArrayPrototypePush(children, child);
+		}
+	}
+
+	require(id) {
+		return requireImpl(this, id, false);
+	}
+
+}
+
+const originalRequire = Module.prototype.require;
+const cacheBuiltins = {__proto__: null};
+
+function requireImpl(mod, id, direct) {
+	if (direct && mod.require !== originalRequire) {
+		return mod.require(id);
+	}
+	const filename = resolver.resolve(mod, id, undefined, Module._extensions, direct);
+	if (localStringPrototypeStartsWith(filename, 'node:')) {
+		id = localStringPrototypeSlice(filename, 5);
+		let nmod = cacheBuiltins[id];
+		if (!nmod) {
+			nmod = resolver.loadBuiltinModule(vm, id);
+			if (!nmod) throw new VMError(`Cannot find module '${filename}'`, 'ENOTFOUND');
+			cacheBuiltins[id] = nmod;
+		}
+		return nmod;
+	}
+
+	const cachedModule = Module._cache[filename];
+	if (cachedModule !== undefined) {
+		mod._updateChildren(cachedModule, false);
+		return cachedModule.exports;
+	}
+
+	let nmod = cacheBuiltins[id];
+	if (nmod) return nmod;
+	nmod = resolver.loadBuiltinModule(vm, id);
+	if (nmod) {
+		cacheBuiltins[id] = nmod;
+		return nmod;
+	}
+
+	const path = resolver.pathDirname(filename);
+	const module = new Module(filename, path, mod);
+	resolver.registerModule(module, filename, path, mod, direct);
+	mod._updateChildren(module, true);
+	try {
+		Module._cache[filename] = module;
+		const handler = findBestExtensionHandler(filename);
+		handler(module, filename);
+		module.loaded = true;
+	} catch (e) {
+		delete Module._cache[filename];
+		const children = mod.children;
+		if (localArrayIsArray(children)) {
+			const index = localArrayPrototypeIndexOf(children, module);
+			if (index !== -1) {
+				localArrayPrototypeSplice(children, index, 1);
+			}
+		}
+		throw e;
+	}
+
+	return module.exports;
+}
+
+Module.builtinModules = ensureSandboxArray(resolver.getBuiltinModulesList());
+Module.globalPaths = globalPaths;
+Module._extensions = {__proto__: null};
+Module._cache = {__proto__: null};
+
+{
+	const keys = Object.getOwnPropertyNames(extensions);
+	for (let i = 0; i < keys.length; i++) {
+		const key = keys[i];
+		const handler = extensions[key];
+		Module._extensions[key] = (mod, filename) => handler(mod, filename);
+	}
+}
+
+function findBestExtensionHandler(filename) {
+	const name = resolver.pathBasename(filename);
+	for (let i = 0; (i = localStringPrototypeIndexOf(name, '.', i + 1)) !== -1;) {
+		const ext = localStringPrototypeSlice(name, i);
+		const handler = Module._extensions[ext];
+		if (handler) return handler;
+	}
+	const js = Module._extensions['.js'];
+	if (js) return js;
+	const keys = Object.getOwnPropertyNames(Module._extensions);
+	if (keys.length === 0) throw new VMError(`Failed to load '${filename}': Unknown type.`, 'ELOADFAIL');
+	return Module._extensions[keys[0]];
+}
+
+function createRequireForModule(mod) {
+	// eslint-disable-next-line no-shadow
+	function require(id) {
+		return requireImpl(mod, id, true);
+	}
+	function resolve(id, options) {
+		return resolver.resolve(mod, id, options, Module._extensions, true);
+	}
+	require.resolve = resolve;
+	function paths(id) {
+		return ensureSandboxArray(resolver.lookupPaths(mod, id));
+	}
+	resolve.paths = paths;
+
+	require.extensions = Module._extensions;
+
+	require.cache = Module._cache;
+
+	return require;
+}
+
+/**
+ * Prepare sandbox.
+ */
+
+const TIMERS = new LocalWeakMap();
+
+class Timeout {
+}
+
+class Interval {
+}
+
+class Immediate {
+}
+
+function clearTimer(timer) {
+	const obj = localReflectApply(localWeakMapGet, TIMERS, [timer]);
+	if (obj) {
+		obj.clear(obj.value);
+	}
+}
+
+// This is a function and not an arrow function, since the original is also a function
+// eslint-disable-next-line no-shadow
+global.setTimeout = function setTimeout(callback, delay, ...args) {
+	if (typeof callback !== 'function') throw new LocalTypeError('"callback" argument must be a function');
+	const obj = new Timeout(callback, args);
+	const cb = () => {
+		localReflectApply(callback, null, args);
+	};
+	const tmr = host.setTimeout(cb, delay);
+
+	const ref = {
+		__proto__: null,
+		clear: host.clearTimeout,
+		value: tmr
+	};
+
+	localReflectApply(localWeakMapSet, TIMERS, [obj, ref]);
+	return obj;
+};
+
+// eslint-disable-next-line no-shadow
+global.setInterval = function setInterval(callback, interval, ...args) {
+	if (typeof callback !== 'function') throw new LocalTypeError('"callback" argument must be a function');
+	const obj = new Interval();
+	const cb = () => {
+		localReflectApply(callback, null, args);
+	};
+	const tmr = host.setInterval(cb, interval);
+
+	const ref = {
+		__proto__: null,
+		clear: host.clearInterval,
+		value: tmr
+	};
+
+	localReflectApply(localWeakMapSet, TIMERS, [obj, ref]);
+	return obj;
+};
+
+// eslint-disable-next-line no-shadow
+global.setImmediate = function setImmediate(callback, ...args) {
+	if (typeof callback !== 'function') throw new LocalTypeError('"callback" argument must be a function');
+	const obj = new Immediate();
+	const cb = () => {
+		localReflectApply(callback, null, args);
+	};
+	const tmr = host.setImmediate(cb);
+
+	const ref = {
+		__proto__: null,
+		clear: host.clearImmediate,
+		value: tmr
+	};
+
+	localReflectApply(localWeakMapSet, TIMERS, [obj, ref]);
+	return obj;
+};
+
+// eslint-disable-next-line no-shadow
+global.clearTimeout = function clearTimeout(timeout) {
+	clearTimer(timeout);
+};
+
+// eslint-disable-next-line no-shadow
+global.clearInterval = function clearInterval(interval) {
+	clearTimer(interval);
+};
+
+// eslint-disable-next-line no-shadow
+global.clearImmediate = function clearImmediate(immediate) {
+	clearTimer(immediate);
+};
+
+const localProcess = host.process;
+
+function vmEmitArgs(event, args) {
+	const allargs = [event];
+	for (let i = 0; i < args.length; i++) {
+		if (!localReflectDefineProperty(allargs, i + 1, {
+			__proto__: null,
+			value: args[i],
+			writable: true,
+			enumerable: true,
+			configurable: true
+		})) throw new LocalError('Unexpected');
+	}
+	return localReflectApply(vm.emit, vm, allargs);
+}
+
+const LISTENERS = new LocalWeakMap();
+const LISTENER_HANDLER = new LocalWeakMap();
+
+/**
+ *
+ * @param {*} name
+ * @param {*} handler
+ * @this process
+ * @return {this}
+ */
+function addListener(name, handler) {
+	if (name !== 'beforeExit' && name !== 'exit') {
+		throw new LocalError(`Access denied to listen for '${name}' event.`);
+	}
+
+	let cb = localReflectApply(localWeakMapGet, LISTENERS, [handler]);
+	if (!cb) {
+		cb = () => {
+			handler();
+		};
+		localReflectApply(localWeakMapSet, LISTENER_HANDLER, [cb, handler]);
+		localReflectApply(localWeakMapSet, LISTENERS, [handler, cb]);
+	}
+
+	localProcess.on(name, cb);
+
+	return this;
+}
+
+/**
+ *
+ * @this process
+ * @return {this}
+ */
+// eslint-disable-next-line no-shadow
+function process() {
+	return this;
+}
+
+const baseUptime = localProcess.uptime();
+
+// FIXME wrong class structure
+global.process = {
+	__proto__: process.prototype,
+	argv: optionArgv !== undefined ? optionArgv : [],
+	title: localProcess.title,
+	version: localProcess.version,
+	versions: localProcess.versions,
+	arch: localProcess.arch,
+	platform: localProcess.platform,
+	env: optionEnv !== undefined ? optionEnv : {},
+	pid: localProcess.pid,
+	features: localProcess.features,
+	nextTick: function nextTick(callback, ...args) {
+		if (typeof callback !== 'function') {
+			throw new LocalError('Callback must be a function.');
+		}
+
+		localProcess.nextTick(()=>{
+			localReflectApply(callback, null, args);
+		});
+	},
+	hrtime: function hrtime(time) {
+		return localProcess.hrtime(time);
+	},
+	uptime: function uptime() {
+		return localProcess.uptime() - baseUptime;
+	},
+	cwd: function cwd() {
+		return localProcess.cwd();
+	},
+	addListener,
+	on: addListener,
+
+	once: function once(name, handler) {
+		if (name !== 'beforeExit' && name !== 'exit') {
+			throw new LocalError(`Access denied to listen for '${name}' event.`);
+		}
+
+		let triggered = false;
+		const cb = () => {
+			if (triggered) return;
+			triggered = true;
+			localProcess.removeListener(name, cb);
+			handler();
+		};
+		localReflectApply(localWeakMapSet, LISTENER_HANDLER, [cb, handler]);
+
+		localProcess.on(name, cb);
+
+		return this;
+	},
+
+	listeners: function listeners(name) {
+		if (name !== 'beforeExit' && name !== 'exit') {
+			// Maybe add ({__proto__:null})[name] to throw when name fails in https://tc39.es/ecma262/#sec-topropertykey.
+			return [];
+		}
+
+		// Filter out listeners, which were not created in this sandbox
+		const all = localProcess.listeners(name);
+		const filtered = [];
+		let j = 0;
+		for (let i = 0; i < all.length; i++) {
+			const h = localReflectApply(localWeakMapGet, LISTENER_HANDLER, [all[i]]);
+			if (h) {
+				if (!localReflectDefineProperty(filtered, j, {
+					__proto__: null,
+					value: h,
+					writable: true,
+					enumerable: true,
+					configurable: true
+				})) throw new LocalError('Unexpected');
+				j++;
+			}
+		}
+		return filtered;
+	},
+
+	removeListener: function removeListener(name, handler) {
+		if (name !== 'beforeExit' && name !== 'exit') {
+			return this;
+		}
+
+		const cb = localReflectApply(localWeakMapGet, LISTENERS, [handler]);
+		if (cb) localProcess.removeListener(name, cb);
+
+		return this;
+	},
+
+	umask: function umask() {
+		if (arguments.length) {
+			throw new LocalError('Access denied to set umask.');
+		}
+
+		return localProcess.umask();
+	}
+};
+
+if (optionConsole === 'inherit') {
+	global.console = host.console;
+} else if (optionConsole === 'redirect') {
+	global.console = {
+		debug(...args) {
+			vmEmitArgs('console.debug', args);
+		},
+		log(...args) {
+			vmEmitArgs('console.log', args);
+		},
+		info(...args) {
+			vmEmitArgs('console.info', args);
+		},
+		warn(...args) {
+			vmEmitArgs('console.warn', args);
+		},
+		error(...args) {
+			vmEmitArgs('console.error', args);
+		},
+		dir(...args) {
+			vmEmitArgs('console.dir', args);
+		},
+		time() {},
+		timeEnd() {},
+		trace(...args) {
+			vmEmitArgs('console.trace', args);
+		}
+	};
+}
+
+return {
+	__proto__: null,
+	Module,
+	jsonParse: JSON.parse,
+	createRequireForModule,
+	requireImpl
+};

dist/setup-sandbox.js

@@ -0,0 +1,457 @@
+/* global host, bridge, data, context */
+
+'use strict';
+
+const {
+	Object: localObject,
+	Array: localArray,
+	Error: LocalError,
+	Reflect: localReflect,
+	Proxy: LocalProxy,
+	WeakMap: LocalWeakMap,
+	Function: localFunction,
+	Promise: localPromise,
+	eval: localEval
+} = global;
+
+const {
+	freeze: localObjectFreeze
+} = localObject;
+
+const {
+	getPrototypeOf: localReflectGetPrototypeOf,
+	apply: localReflectApply,
+	deleteProperty: localReflectDeleteProperty,
+	has: localReflectHas,
+	defineProperty: localReflectDefineProperty,
+	setPrototypeOf: localReflectSetPrototypeOf,
+	getOwnPropertyDescriptor: localReflectGetOwnPropertyDescriptor
+} = localReflect;
+
+const {
+	isArray: localArrayIsArray
+} = localArray;
+
+const {
+	ensureThis,
+	ReadOnlyHandler,
+	from,
+	fromWithFactory,
+	readonlyFactory,
+	connect,
+	addProtoMapping,
+	VMError,
+	ReadOnlyMockHandler
+} = bridge;
+
+const {
+	allowAsync,
+	GeneratorFunction,
+	AsyncFunction,
+	AsyncGeneratorFunction
+} = data;
+
+const {
+	get: localWeakMapGet,
+	set: localWeakMapSet
+} = LocalWeakMap.prototype;
+
+function localUnexpected() {
+	return new VMError('Should not happen');
+}
+
+// global is originally prototype of host.Object so it can be used to climb up from the sandbox.
+if (!localReflectSetPrototypeOf(context, localObject.prototype)) throw localUnexpected();
+
+Object.defineProperties(global, {
+	global: {value: global, writable: true, configurable: true, enumerable: true},
+	globalThis: {value: global, writable: true, configurable: true},
+	GLOBAL: {value: global, writable: true, configurable: true},
+	root: {value: global, writable: true, configurable: true},
+	Error: {value: LocalError}
+});
+
+if (!localReflectDefineProperty(global, 'VMError', {
+	__proto__: null,
+	value: VMError,
+	writable: true,
+	enumerable: false,
+	configurable: true
+})) throw localUnexpected();
+
+// Fixes buffer unsafe allocation
+/* eslint-disable no-use-before-define */
+class BufferHandler extends ReadOnlyHandler {
+
+	apply(target, thiz, args) {
+		if (args.length > 0 && typeof args[0] === 'number') {
+			return LocalBuffer.alloc(args[0]);
+		}
+		return localReflectApply(LocalBuffer.from, LocalBuffer, args);
+	}
+
+	construct(target, args, newTarget) {
+		if (args.length > 0 && typeof args[0] === 'number') {
+			return LocalBuffer.alloc(args[0]);
+		}
+		return localReflectApply(LocalBuffer.from, LocalBuffer, args);
+	}
+
+}
+/* eslint-enable no-use-before-define */
+
+const LocalBuffer = fromWithFactory(obj => new BufferHandler(obj), host.Buffer);
+
+
+if (!localReflectDefineProperty(global, 'Buffer', {
+	__proto__: null,
+	value: LocalBuffer,
+	writable: true,
+	enumerable: false,
+	configurable: true
+})) throw localUnexpected();
+
+addProtoMapping(LocalBuffer.prototype, host.Buffer.prototype, 'Uint8Array');
+
+/**
+ *
+ * @param {*} size Size of new buffer
+ * @this LocalBuffer
+ * @return {LocalBuffer}
+ */
+function allocUnsafe(size) {
+	return LocalBuffer.alloc(size);
+}
+
+connect(allocUnsafe, host.Buffer.allocUnsafe);
+
+/**
+ *
+ * @param {*} size Size of new buffer
+ * @this LocalBuffer
+ * @return {LocalBuffer}
+ */
+function allocUnsafeSlow(size) {
+	return LocalBuffer.alloc(size);
+}
+
+connect(allocUnsafeSlow, host.Buffer.allocUnsafeSlow);
+
+/**
+ * Replacement for Buffer inspect
+ *
+ * @param {*} recurseTimes
+ * @param {*} ctx
+ * @this LocalBuffer
+ * @return {string}
+ */
+function inspect(recurseTimes, ctx) {
+	// Mimic old behavior, could throw but didn't pass a test.
+	const max = host.INSPECT_MAX_BYTES;
+	const actualMax = Math.min(max, this.length);
+	const remaining = this.length - max;
+	let str = this.hexSlice(0, actualMax).replace(/(.{2})/g, '$1 ').trim();
+	if (remaining > 0) str += ` ... ${remaining} more byte${remaining > 1 ? 's' : ''}`;
+	return `<${this.constructor.name} ${str}>`;
+}
+
+connect(inspect, host.Buffer.prototype.inspect);
+
+connect(localFunction.prototype.bind, host.Function.prototype.bind);
+
+connect(localObject.prototype.__defineGetter__, host.Object.prototype.__defineGetter__);
+connect(localObject.prototype.__defineSetter__, host.Object.prototype.__defineSetter__);
+connect(localObject.prototype.__lookupGetter__, host.Object.prototype.__lookupGetter__);
+connect(localObject.prototype.__lookupSetter__, host.Object.prototype.__lookupSetter__);
+
+/*
+ * PrepareStackTrace sanitization
+ */
+
+const oldPrepareStackTraceDesc = localReflectGetOwnPropertyDescriptor(LocalError, 'prepareStackTrace');
+
+let currentPrepareStackTrace = LocalError.prepareStackTrace;
+const wrappedPrepareStackTrace = new LocalWeakMap();
+if (typeof currentPrepareStackTrace === 'function') {
+	wrappedPrepareStackTrace.set(currentPrepareStackTrace, currentPrepareStackTrace);
+}
+
+let OriginalCallSite;
+LocalError.prepareStackTrace = (e, sst) => {
+	OriginalCallSite = sst[0].constructor;
+};
+new LocalError().stack;
+if (typeof OriginalCallSite === 'function') {
+	LocalError.prepareStackTrace = undefined;
+
+	function makeCallSiteGetters(list) {
+		const callSiteGetters = [];
+		for (let i=0; i<list.length; i++) {
+			const name = list[i];
+			const func = OriginalCallSite.prototype[name];
+			callSiteGetters[i] = {__proto__: null,
+				name,
+				propName: '_' + name,
+				func: (thiz) => {
+					return localReflectApply(func, thiz, []);
+				}
+			};
+		}
+		return callSiteGetters;
+	}
+
+	function applyCallSiteGetters(thiz, callSite, getters) {
+		for (let i=0; i<getters.length; i++) {
+			const getter = getters[i];
+			localReflectDefineProperty(thiz, getter.propName, {
+				__proto__: null,
+				value: getter.func(callSite)
+			});
+		}
+	}
+
+	const callSiteGetters = makeCallSiteGetters([
+		'getTypeName',
+		'getFunctionName',
+		'getMethodName',
+		'getFileName',
+		'getLineNumber',
+		'getColumnNumber',
+		'getEvalOrigin',
+		'isToplevel',
+		'isEval',
+		'isNative',
+		'isConstructor',
+		'isAsync',
+		'isPromiseAll',
+		'getPromiseIndex'
+	]);
+
+	class CallSite {
+		constructor(callSite) {
+			applyCallSiteGetters(this, callSite, callSiteGetters);
+		}
+		getThis() {
+			return undefined;
+		}
+		getFunction() {
+			return undefined;
+		}
+		toString() {
+			return 'CallSite {}';
+		}
+	}
+
+
+	for (let i=0; i<callSiteGetters.length; i++) {
+		const name = callSiteGetters[i].name;
+		const funcProp = localReflectGetOwnPropertyDescriptor(OriginalCallSite.prototype, name);
+		if (!funcProp) continue;
+		const propertyName = callSiteGetters[i].propName;
+		const func = {func() {
+			return this[propertyName];
+		}}.func;
+		const nameProp = localReflectGetOwnPropertyDescriptor(func, 'name');
+		if (!nameProp) throw localUnexpected();
+		nameProp.value = name;
+		if (!localReflectDefineProperty(func, 'name', nameProp)) throw localUnexpected();
+		funcProp.value = func;
+		if (!localReflectDefineProperty(CallSite.prototype, name, funcProp)) throw localUnexpected();
+	}
+
+	if (!localReflectDefineProperty(LocalError, 'prepareStackTrace', {
+		configurable: false,
+		enumerable: false,
+		get() {
+			return currentPrepareStackTrace;
+		},
+		set(value) {
+			if (typeof(value) !== 'function') {
+				currentPrepareStackTrace = value;
+				return;
+			}
+			const wrapped = localReflectApply(localWeakMapGet, wrappedPrepareStackTrace, [value]);
+			if (wrapped) {
+				currentPrepareStackTrace = wrapped;
+				return;
+			}
+			const newWrapped = (error, sst) => {
+				if (localArrayIsArray(sst)) {
+					for (let i=0; i < sst.length; i++) {
+						const cs = sst[i];
+						if (typeof cs === 'object' && localReflectGetPrototypeOf(cs) === OriginalCallSite.prototype) {
+							sst[i] = new CallSite(cs);
+						}
+					}
+				}
+				return value(error, sst);
+			};
+			localReflectApply(localWeakMapSet, wrappedPrepareStackTrace, [value, newWrapped]);
+			localReflectApply(localWeakMapSet, wrappedPrepareStackTrace, [newWrapped, newWrapped]);
+			currentPrepareStackTrace = newWrapped;
+		}
+	})) throw localUnexpected();
+} else if (oldPrepareStackTraceDesc) {
+	localReflectDefineProperty(LocalError, 'prepareStackTrace', oldPrepareStackTraceDesc);
+} else {
+	localReflectDeleteProperty(LocalError, 'prepareStackTrace');
+}
+
+/*
+ * Exception sanitization
+ */
+
+const withProxy = localObjectFreeze({
+	__proto__: null,
+	has(target, key) {
+		if (key === host.INTERNAL_STATE_NAME) return false;
+		return localReflectHas(target, key);
+	}
+});
+
+const interanState = localObjectFreeze({
+	__proto__: null,
+	wrapWith(x) {
+		if (x === null || x === undefined) return x;
+		return new LocalProxy(localObject(x), withProxy);
+	},
+	handleException: ensureThis,
+	import(what) {
+		throw new VMError('Dynamic Import not supported');
+	}
+});
+
+if (!localReflectDefineProperty(global, host.INTERNAL_STATE_NAME, {
+	__proto__: null,
+	configurable: false,
+	enumerable: false,
+	writable: false,
+	value: interanState
+})) throw localUnexpected();
+
+/*
+ * Eval sanitization
+ */
+
+function throwAsync() {
+	return new VMError('Async not available');
+}
+
+function makeFunction(inputArgs, isAsync, isGenerator) {
+	const lastArgs = inputArgs.length - 1;
+	let code = lastArgs >= 0 ? `${inputArgs[lastArgs]}` : '';
+	let args = lastArgs > 0 ? `${inputArgs[0]}` : '';
+	for (let i = 1; i < lastArgs; i++) {
+		args += `,${inputArgs[i]}`;
+	}
+	try {
+		code = host.transformAndCheck(args, code, isAsync, isGenerator, allowAsync);
+	} catch (e) {
+		throw bridge.from(e);
+	}
+	return localEval(code);
+}
+
+const FunctionHandler = {
+	__proto__: null,
+	apply(target, thiz, args) {
+		return makeFunction(args, this.isAsync, this.isGenerator);
+	},
+	construct(target, args, newTarget) {
+		return makeFunction(args, this.isAsync, this.isGenerator);
+	}
+};
+
+const EvalHandler = {
+	__proto__: null,
+	apply(target, thiz, args) {
+		if (args.length === 0) return undefined;
+		let code = `${args[0]}`;
+		try {
+			code = host.transformAndCheck(null, code, false, false, allowAsync);
+		} catch (e) {
+			throw bridge.from(e);
+		}
+		return localEval(code);
+	}
+};
+
+const AsyncErrorHandler = {
+	__proto__: null,
+	apply(target, thiz, args) {
+		throw throwAsync();
+	},
+	construct(target, args, newTarget) {
+		throw throwAsync();
+	}
+};
+
+function makeCheckFunction(isAsync, isGenerator) {
+	if (isAsync && !allowAsync) return AsyncErrorHandler;
+	return {
+		__proto__: FunctionHandler,
+		isAsync,
+		isGenerator
+	};
+}
+
+function overrideWithProxy(obj, prop, value, handler) {
+	const proxy = new LocalProxy(value, handler);
+	if (!localReflectDefineProperty(obj, prop, {__proto__: null, value: proxy})) throw localUnexpected();
+	return proxy;
+}
+
+const proxiedFunction = overrideWithProxy(localFunction.prototype, 'constructor', localFunction, makeCheckFunction(false, false));
+if (GeneratorFunction) {
+	if (!localReflectSetPrototypeOf(GeneratorFunction, proxiedFunction)) throw localUnexpected();
+	overrideWithProxy(GeneratorFunction.prototype, 'constructor', GeneratorFunction, makeCheckFunction(false, true));
+}
+if (AsyncFunction) {
+	if (!localReflectSetPrototypeOf(AsyncFunction, proxiedFunction)) throw localUnexpected();
+	overrideWithProxy(AsyncFunction.prototype, 'constructor', AsyncFunction, makeCheckFunction(true, false));
+}
+if (AsyncGeneratorFunction) {
+	if (!localReflectSetPrototypeOf(AsyncGeneratorFunction, proxiedFunction)) throw localUnexpected();
+	overrideWithProxy(AsyncGeneratorFunction.prototype, 'constructor', AsyncGeneratorFunction, makeCheckFunction(true, true));
+}
+
+global.Function = proxiedFunction;
+global.eval = new LocalProxy(localEval, EvalHandler);
+
+/*
+ * Promise sanitization
+ */
+
+if (localPromise && !allowAsync) {
+
+	const PromisePrototype = localPromise.prototype;
+
+	overrideWithProxy(PromisePrototype, 'then', PromisePrototype.then, AsyncErrorHandler);
+	// This seems not to work, and will produce
+	// UnhandledPromiseRejectionWarning: TypeError: Method Promise.prototype.then called on incompatible receiver [object Object].
+	// This is likely caused since the host.Promise.prototype.then cannot use the VM Proxy object.
+	// Contextify.connect(host.Promise.prototype.then, Promise.prototype.then);
+
+	if (PromisePrototype.finally) {
+		overrideWithProxy(PromisePrototype, 'finally', PromisePrototype.finally, AsyncErrorHandler);
+		// Contextify.connect(host.Promise.prototype.finally, Promise.prototype.finally);
+	}
+	if (Promise.prototype.catch) {
+		overrideWithProxy(PromisePrototype, 'catch', PromisePrototype.catch, AsyncErrorHandler);
+		// Contextify.connect(host.Promise.prototype.catch, Promise.prototype.catch);
+	}
+
+}
+
+function readonly(other, mock) {
+	// Note: other@other(unsafe) mock@other(unsafe) returns@this(unsafe) throws@this(unsafe)
+	if (!mock) return fromWithFactory(readonlyFactory, other);
+	const tmock = from(mock);
+	return fromWithFactory(obj=>new ReadOnlyMockHandler(obj, tmock), other);
+}
+
+return {
+	__proto__: null,
+	readonly,
+	global
+};

dist/src/create-pull-request.py

@@ -1,262 +0,0 @@
-#!/usr/bin/env python3
-''' Create Pull Request '''
-import json
-import os
-import random
-import string
-import sys
-import time
-from git import Repo
-from github import Github
-from github import GithubException
-
-
-def get_github_event(github_event_path):
-    with open(github_event_path) as f:
-        github_event = json.load(f)
-    if bool(os.environ.get('DEBUG_EVENT')):
-        print(os.environ['GITHUB_EVENT_NAME'])
-        print(json.dumps(github_event, sort_keys=True, indent=2))
-    return github_event
-
-
-def get_head_short_sha1(repo):
-    return repo.git.rev_parse('--short', 'HEAD')
-
-
-def get_random_suffix(size=7, chars=string.ascii_lowercase + string.digits):
-    return ''.join(random.choice(chars) for _ in range(size))
-
-
-def remote_branch_exists(repo, branch):
-    for ref in repo.remotes.origin.refs:
-        if ref.name == ("origin/%s" % branch):
-            return True
-    return False
-
-
-def get_author_default(event_name, event_data):
-    if event_name == "push":
-        email = "{head_commit[author][email]}".format(**event_data)
-        name = "{head_commit[author][name]}".format(**event_data)
-    else:
-        email = os.environ['GITHUB_ACTOR'] + '@users.noreply.github.com'
-        name = os.environ['GITHUB_ACTOR']
-    return email, name
-
-
-def set_git_config(git, email, name):
-    git.config('--global', 'user.email', '"%s"' % email)
-    git.config('--global', 'user.name', '"%s"' % name)
-
-
-def set_git_remote_url(git, token, github_repository):
-    git.remote(
-        'set-url', 'origin', "https://x-access-token:%s@github.com/%s" %
-        (token, github_repository))
-
-
-def checkout_branch(git, remote_exists, branch):
-    if remote_exists:
-        git.stash('--include-untracked')
-        git.checkout(branch)
-        try:
-            git.stash('pop')
-        except BaseException:
-            git.checkout('--theirs', '.')
-            git.reset()
-    else:
-        git.checkout('HEAD', b=branch)
-
-
-def push_changes(git, branch, commit_message):
-    git.add('-A')
-    git.commit(m=commit_message)
-    return git.push('-f', '--set-upstream', 'origin', branch)
-
-
-def cs_string_to_list(str):
-    # Split the comma separated string into a list
-    l = [i.strip() for i in str.split(',')]
-    # Remove empty strings
-    return list(filter(None, l))
-
-
-def process_event(github_token, github_repository, repo, branch, base):
-    # Fetch optional environment variables with default values
-    commit_message = os.getenv(
-        'COMMIT_MESSAGE',
-        "Auto-committed changes by create-pull-request action")
-    title = os.getenv(
-        'PULL_REQUEST_TITLE',
-        "Auto-generated by create-pull-request action")
-    body = os.getenv(
-        'PULL_REQUEST_BODY', "Auto-generated pull request by "
-        "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action")
-    # Fetch optional environment variables with no default values
-    pull_request_labels = os.environ.get('PULL_REQUEST_LABELS')
-    pull_request_assignees = os.environ.get('PULL_REQUEST_ASSIGNEES')
-    pull_request_milestone = os.environ.get('PULL_REQUEST_MILESTONE')
-    pull_request_reviewers = os.environ.get('PULL_REQUEST_REVIEWERS')
-    pull_request_team_reviewers = os.environ.get('PULL_REQUEST_TEAM_REVIEWERS')
-
-    # Push the local changes to the remote branch
-    print("Pushing changes.")
-    push_result = push_changes(repo.git, branch, commit_message)
-    print(push_result)
-
-    # Create the pull request
-    github_repo = Github(github_token).get_repo(github_repository)
-    try:
-        pull_request = github_repo.create_pull(
-            title=title,
-            body=body,
-            base=base,
-            head=branch)
-        print("Created pull request #%d (%s => %s)" %
-            (pull_request.number, branch, base))
-    except GithubException as e:
-        if e.status == 422:
-            pull_request = github_repo.get_pulls(
-                state='open', 
-                base=base,
-                head=branch)[0]
-            print("Updated pull request #%d (%s => %s)" %
-                (pull_request.number, branch, base))
-        else:
-            print(str(e))
-            sys.exit(1)
-
-    # Set the output variables
-    os.system(
-        'echo ::set-env name=PULL_REQUEST_NUMBER::%d' %
-        pull_request.number)
-    os.system(
-        'echo ::set-output name=pr_number::%d' %
-        pull_request.number)
-
-    # Set labels, assignees and milestone
-    if pull_request_labels is not None:
-        print("Applying labels")
-        pull_request.as_issue().edit(labels=cs_string_to_list(pull_request_labels))
-    if pull_request_assignees is not None:
-        print("Applying assignees")
-        pull_request.as_issue().edit(assignees=cs_string_to_list(pull_request_assignees))
-    if pull_request_milestone is not None:
-        print("Applying milestone")
-        milestone = github_repo.get_milestone(int(pull_request_milestone))
-        pull_request.as_issue().edit(milestone=milestone)
-
-    # Set pull request reviewers
-    if pull_request_reviewers is not None:
-        print("Requesting reviewers")
-        try:
-            pull_request.create_review_request(
-                reviewers=cs_string_to_list(pull_request_reviewers))
-        except GithubException as e:
-            # Likely caused by "Review cannot be requested from pull request author."
-            if e.status == 422:
-                print("Requesting reviewers failed - %s" % e.data["message"])
-
-    # Set pull request team reviewers
-    if pull_request_team_reviewers is not None:
-        print("Requesting team reviewers")
-        pull_request.create_review_request(
-            team_reviewers=cs_string_to_list(pull_request_team_reviewers))
-
-
-# Fetch environment variables
-github_token = os.environ['GITHUB_TOKEN']
-github_repository = os.environ['GITHUB_REPOSITORY']
-github_ref = os.environ['GITHUB_REF']
-event_name = os.environ['GITHUB_EVENT_NAME']
-# Get the JSON event data
-event_data = get_github_event(os.environ['GITHUB_EVENT_PATH'])
-
-# Set the repo to the working directory
-repo = Repo(os.getcwd())
-# Get the default for author email and name
-author_email, author_name = get_author_default(event_name, event_data)
-# Set commit author overrides
-author_email = os.getenv('COMMIT_AUTHOR_EMAIL', author_email)
-author_name = os.getenv('COMMIT_AUTHOR_NAME', author_name)
-# Set git configuration
-set_git_config(repo.git, author_email, author_name)
-# Update URL for the 'origin' remote
-set_git_remote_url(repo.git, github_token, github_repository)
-
-# Fetch/Set the branch name
-branch_prefix = os.getenv(
-    'PULL_REQUEST_BRANCH',
-    'create-pull-request/patch')
-# Fetch an optional base branch override
-base_override = os.environ.get('PULL_REQUEST_BASE')
-
-# Set the base branch
-if base_override is not None:
-    base = base_override
-    checkout_branch(repo.git, True, base)
-elif github_ref.startswith('refs/pull/'):
-    # Switch to the merging branch instead of the merge commit
-    base = os.environ['GITHUB_HEAD_REF']
-    repo.git.checkout(base)
-else:
-    base = github_ref[11:]
-
-# Skip if the current branch is a PR branch created by this action.
-# This may occur when using a PAT instead of GITHUB_TOKEN.
-if base.startswith(branch_prefix):
-    print("Branch '%s' was created by this action. Skipping." % base)
-    sys.exit()
-
-# Fetch an optional environment variable to determine the branch suffix
-branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
-if branch_suffix == "short-commit-hash":
-    # Suffix with the short SHA1 hash
-    branch = "%s-%s" % (branch_prefix, get_head_short_sha1(repo))
-elif branch_suffix == "timestamp":
-    # Suffix with the current timestamp
-    branch = "%s-%s" % (branch_prefix, int(time.time()))
-elif branch_suffix == "random":
-    # Suffix with the current timestamp
-    branch = "%s-%s" % (branch_prefix, get_random_suffix())
-elif branch_suffix == "none":
-    # Fixed branch name
-    branch = branch_prefix
-else:
-    print(
-        "Branch suffix '%s' is not a valid value." %
-        branch_suffix)
-    sys.exit(1)
-
-# Check if the remote branch exists
-remote_exists = remote_branch_exists(repo, branch)
-
-if remote_exists:
-    if branch_suffix == 'short-commit-hash':
-        # A remote branch already exists for the HEAD commit
-        print(
-            "Pull request branch '%s' already exists for this commit. Skipping." %
-            branch)
-        sys.exit()
-    elif branch_suffix in ['timestamp', 'random']:
-        # Generated branch name clash with an existing branch
-        print(
-            "Pull request branch '%s' already exists. Please re-run." %
-            branch)
-        sys.exit(1)
-
-# Checkout branch
-checkout_branch(repo.git, remote_exists, branch)
-
-# Check if there are changes to pull request
-if repo.is_dirty() or len(repo.untracked_files) > 0:
-    print("Repository has modified or untracked files.")
-    process_event(
-        github_token,
-        github_repository,
-        repo,
-        branch,
-        base)
-else:
-    print("Repository has no modified or untracked files. Skipping.")

dist/src/requirements.txt

@@ -1,2 +0,0 @@
-GitPython==3.0.4
-PyGithub==1.44.1

dist/src/setup-python.js

@@ -1,52 +0,0 @@
-const core = require("@actions/core");
-const tc = require("@actions/tool-cache");
-const path = require("path");
-const semver = require("semver");
-
-/**
- * Setup for Python from the GitHub Actions tool cache
- * Converted from https://github.com/actions/setup-python
- *
- * @param {string} versionSpec version of Python
- * @param {string} arch architecture (x64|x32)
- */
-let setupPython = function(versionSpec, arch) {
-  return new Promise((resolve, reject) => {
-    const IS_WINDOWS = process.platform === "win32";
-
-    // Find the version of Python we want in the tool cache
-    const installDir = tc.find("Python", versionSpec, arch);
-    core.debug(`installDir: ${installDir}`);
-
-    // Set paths
-    core.exportVariable("pythonLocation", installDir);
-    core.addPath(installDir);
-    if (IS_WINDOWS) {
-      core.addPath(path.join(installDir, "Scripts"));
-    } else {
-      core.addPath(path.join(installDir, "bin"));
-    }
-
-    if (IS_WINDOWS) {
-      // Add --user directory
-      // `installDir` from tool cache should look like $AGENT_TOOLSDIRECTORY/Python/<semantic version>/x64/
-      // So if `findLocalTool` succeeded above, we must have a conformant `installDir`
-      const version = path.basename(path.dirname(installDir));
-      const major = semver.major(version);
-      const minor = semver.minor(version);
-
-      const userScriptsDir = path.join(
-        process.env["APPDATA"] || "",
-        "Python",
-        `Python${major}${minor}`,
-        "Scripts"
-      );
-      core.addPath(userScriptsDir);
-    }
-    // On Linux and macOS, pip will create the --user directory and add it to PATH as needed.
-
-    resolve();
-  });
-};
-
-module.exports = setupPython;

docs/assets/cpr-gitgraph.htm

@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <title>create-pull-request GitHub action</title>
+</head>
+
+<body>
+    <!-- partial:index.partial.html -->
+    <div id="graph-container"></div>
+    <!-- partial -->
+    <script src='https://cdn.jsdelivr.net/npm/@gitgraph/js'></script>
+    <script>
+        const graphContainer = document.getElementById("graph-container");
+
+        const customTemplate = GitgraphJS.templateExtend(GitgraphJS.TemplateName.Metro, {
+            commit: {
+                message: {
+                    displayAuthor: false,
+                    displayHash: false,
+                },
+            },
+        });
+
+        // Instantiate the graph.
+        const gitgraph = GitgraphJS.createGitgraph(graphContainer, {
+            template: customTemplate,
+            orientation: "vertical-reverse"
+        });
+
+        const main = gitgraph.branch("main");
+        main.commit("Last commit on base");
+        const localMain = gitgraph.branch("<#1> main (local)");
+        localMain.commit({
+            subject: "<uncommitted changes>",
+            body: "Changes to the local base during the workflow",
+        })
+        const remotePatch = gitgraph.branch("create-pull-request/patch");
+        remotePatch.merge({
+            branch: localMain,
+            commitOptions: {
+                subject: "[create-pull-request] automated change",
+                body: "Changes pushed to create the remote branch",
+            },
+        });
+        main.commit("New commit on base");
+
+        const localMain2 = gitgraph.branch("<#2> main (local)");
+        localMain2.commit({
+            subject: "<uncommitted changes>",
+            body: "Changes to the updated local base during the workflow",
+        })
+        remotePatch.merge({
+            branch: localMain2,
+            commitOptions: {
+                subject: "[create-pull-request] automated change",
+                body: "Changes force pushed to update the remote branch",
+            },
+        });
+
+        main.merge(remotePatch);
+
+    </script>
+
+</body>
+
+</html>

docs/concepts-guidelines.md

@@ -0,0 +1,371 @@
+# Concepts, guidelines and advanced usage
+
+This document covers terminology, how the action works, general usage guidelines, and advanced usage.
+
+- [Terminology](#terminology)
+- [Events and checkout](#events-and-checkout)
+- [How the action works](#how-the-action-works)
+- [Guidelines](#guidelines)
+  - [Providing a consistent base](#providing-a-consistent-base)
+  - [Events which checkout a commit](#events-which-checkout-a-commit)
+  - [Restrictions on repository forks](#restrictions-on-repository-forks)
+  - [Triggering further workflow runs](#triggering-further-workflow-runs)
+  - [Security](#security)
+- [Advanced usage](#advanced-usage)
+  - [Creating pull requests in a remote repository](#creating-pull-requests-in-a-remote-repository)
+  - [Push using SSH (deploy keys)](#push-using-ssh-deploy-keys)
+  - [Push pull request branches to a fork](#push-pull-request-branches-to-a-fork)
+  - [Authenticating with GitHub App generated tokens](#authenticating-with-github-app-generated-tokens)
+  - [GPG commit signature verification](#gpg-commit-signature-verification)
+  - [Running in a container or on self-hosted runners](#running-in-a-container-or-on-self-hosted-runners)
+
+## Terminology
+
+[Pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#about-pull-requests) are proposed changes to a repository branch that can be reviewed by a repository's collaborators before being accepted or rejected. 
+
+A pull request references two branches:
+
+- The `base` of a pull request is the branch you intend to change once the proposed changes are merged.
+- The `branch` of a pull request represents what you intend the `base` to look like when merged. It is the `base` branch *plus* changes that have been made to it.
+
+## Events and checkout
+
+This action expects repositories to be checked out with the official GitHub Actions [checkout](https://github.com/actions/checkout) action.
+For each [event type](https://docs.github.com/en/actions/reference/events-that-trigger-workflows) there is a default `GITHUB_SHA` that will be checked out.
+
+The default can be overridden by specifying a `ref` on checkout.
+
+```yml
+      - uses: actions/checkout@v3
+        with:
+          ref: develop
+```
+
+## How the action works
+
+Unless the `base` input is supplied, the action expects the target repository to be checked out on the pull request `base`—the branch you intend to modify with the proposed changes.
+
+Workflow steps:
+
+1. Checkout the `base` branch
+2. Make changes
+3. Execute `create-pull-request` action
+
+The following git diagram shows how the action creates and updates a pull request branch.
+
+![Create Pull Request GitGraph](assets/cpr-gitgraph.png)
+
+## Guidelines
+
+### Providing a consistent base
+
+For the action to work correctly it should be executed in a workflow that checks out a *consistent* base branch. This will be the base of the pull request unless overridden with the `base` input.
+
+This means your workflow should be consistently checking out the branch that you intend to modify once the PR is merged.
+
+In the following example, the [`push`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#push) and [`create`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#create) events both trigger the same workflow. This will cause the checkout action to checkout inconsistent branches and commits. Do *not* do this. It will cause multiple pull requests to be created for each additional `base` the action is executed against.
+
+```yml
+on:
+  push:
+  create:
+jobs:
+  example:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+```
+
+There may be use cases where it makes sense to execute the workflow on a branch that is not the base of the pull request. In these cases, the base branch can be specified with the `base` action input. The action will attempt to rebase changes made during the workflow on to the actual base.
+
+### Events which checkout a commit
+
+The [default checkout](#events-and-checkout) for the majority of events will leave the repository checked out on a branch.
+However, some events such as `release` and `pull_request` will leave the repository in a "detached HEAD" state.
+This is because they checkout a commit, not a branch.
+In these cases, you *must supply* the `base` input so the action can rebase changes made during the workflow for the pull request.
+
+Workflows triggered by [`pull_request`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request) events will by default check out a merge commit. Set the `base` input as follows to base the new pull request on the current pull request's branch.
+
+```yml
+      - uses: peter-evans/create-pull-request@v4
+        with:
+          base: ${{ github.head_ref }}
+```
+
+Workflows triggered by [`release`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release) events will by default check out a tag. For most use cases, you will need to set the `base` input to the branch name of the tagged commit.
+
+```yml
+      - uses: peter-evans/create-pull-request@v4
+        with:
+          base: main
+```
+
+### Restrictions on repository forks
+
+GitHub Actions have imposed restrictions on workflow runs triggered by public repository forks.
+Private repositories can be configured to [enable workflows](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) from forks to run without restriction.
+
+The restrictions apply to the `pull_request` event triggered by a fork opening a pull request in the upstream repository.
+
+- Events from forks cannot access secrets, except for the default `GITHUB_TOKEN`.
+    > With the exception of GITHUB_TOKEN, secrets are not passed to the runner when a workflow is triggered from a forked repository.
+
+    [GitHub Actions: Using encrypted secrets in a workflow](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#using-encrypted-secrets-in-a-workflow)
+
+- The `GITHUB_TOKEN` has read-only access when an event is triggered by a forked repository.
+
+   [GitHub Actions: Permissions for the GITHUB_TOKEN](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token)
+
+These restrictions mean that during a `pull_request` event triggered by a forked repository, actions have no write access to GitHub resources and will fail on any attempt.
+
+A job condition can be added to prevent workflows from executing when triggered by a repository fork.
+
+```yml
+on: pull_request
+jobs:
+  example:
+    runs-on: ubuntu-latest
+    # Check if the event is not triggered by a fork
+    if: github.event.pull_request.head.repo.full_name == github.repository
+```
+
+For further reading regarding the security of pull requests, see this GitHub blog post titled [Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/)
+
+### Triggering further workflow runs
+
+Pull requests created by the action using the default `GITHUB_TOKEN` cannot trigger other workflows. If you have `on: pull_request` or `on: push` workflows acting as checks on pull requests, they will not run.
+
+> When you use the repository's `GITHUB_TOKEN` to perform tasks, events triggered by the `GITHUB_TOKEN` will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs. For example, if a workflow run pushes code using the repository's `GITHUB_TOKEN`, a new workflow will not run even when the repository contains a workflow configured to run when `push` events occur.
+
+[GitHub Actions: Triggering a workflow from a workflow](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow)
+
+#### Workarounds to trigger further workflow runs
+
+There are a number of workarounds with different pros and cons.
+
+- Use the default `GITHUB_TOKEN` and allow the action to create pull requests that have no checks enabled. Manually close pull requests and immediately reopen them. This will enable `on: pull_request` workflows to run and be added as checks. To prevent merging of pull requests without checks erroneously, use [branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests).
+
+- Use a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) created on an account that has write access to the repository that pull requests are being created in. This is the standard workaround and [recommended by GitHub](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token). However, the PAT cannot be scoped to a specific repository so the token becomes a very sensitive secret. If this is a concern, the PAT can instead be created for a dedicated [machine account](https://docs.github.com/en/github/site-policy/github-terms-of-service#3-account-requirements) that has collaborator access to the repository. Also note that because the account that owns the PAT will be the creator of pull requests, that user account will be unable to perform actions such as request changes or approve the pull request.
+
+- Use [SSH (deploy keys)](#push-using-ssh-deploy-keys) to push the pull request branch. This is arguably more secure than using a PAT because deploy keys can be set per repository. However, this method will only trigger `on: push` workflows.
+
+- Use a [machine account that creates pull requests from its own fork](#push-pull-request-branches-to-a-fork). This is the most secure because the PAT created only grants access to the machine account's fork, not the main repository. This method will trigger `on: pull_request` workflows to run. Workflows triggered `on: push` will not run because the push event is in the fork.
+
+- Use a [GitHub App to generate a token](#authenticating-with-github-app-generated-tokens) that can be used with this action. GitHub App generated tokens are more secure than using a PAT because GitHub App access permissions can be set with finer granularity and are scoped to only repositories where the App is installed. This method will trigger both `on: push` and `on: pull_request` workflows.
+
+### Security
+
+From a security perspective it's good practice to fork third-party actions, review the code, and use your fork of the action in workflows.
+By using third-party actions directly the risk exists that it could be modified to do something malicious, such as capturing secrets.
+
+Alternatively, use the action directly and reference the commit hash for the version you want to target.
+```yml
+  - uses: thirdparty/foo-action@172ec762f2ac8e050062398456fccd30444f8f30
+```
+
+This action uses [ncc](https://github.com/vercel/ncc) to compile the Node.js code and dependencies into a single JavaScript file under the [dist](https://github.com/peter-evans/create-pull-request/tree/main/dist) directory.
+
+## Advanced usage
+
+### Creating pull requests in a remote repository
+
+Checking out a branch from a different repository from where the workflow is executing will make *that repository* the target for the created pull request. In this case, a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required.
+
+```yml
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT }}
+          repository: owner/repo
+
+      # Make changes to pull request here
+
+      - uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.PAT }}
+```
+
+### Push using SSH (deploy keys)
+
+[Deploy keys](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) can be set per repository and so are arguably more secure than using a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
+Allowing the action to push with a configured deploy key will trigger `on: push` workflows. This makes it an alternative to using a PAT to trigger checks for pull requests.
+Note that you cannot use deploy keys alone to [create a pull request in a remote repository](#creating-pull-requests-in-a-remote-repository) because then using a PAT would become a requirement. This method only makes sense if creating a pull request in the repository where the workflow is running.
+
+How to use SSH (deploy keys) with create-pull-request action:
+
+1. [Create a new SSH key pair](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key) for your repository. Do not set a passphrase.
+2. Copy the contents of the public key (.pub file) to a new repository [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) and check the box to "Allow write access."
+3. Add a secret to the repository containing the entire contents of the private key.
+4. As shown in the example below, configure `actions/checkout` to use the deploy key you have created.
+
+```yml
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+```
+
+### Push pull request branches to a fork
+
+Instead of pushing pull request branches to the repository you want to update, you can push them to a fork of that repository.
+This allows you to employ the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege) by using a dedicated user acting as a [machine account](https://docs.github.com/en/github/site-policy/github-terms-of-service#3-account-requirements).
+This user only has `read` access to the main repository.
+It will use their own fork to push code and create the pull request.
+Note that if you choose to use this method (not give the machine account `write` access to the repository) the following inputs cannot be used: `labels`, `assignees`, `reviewers`, `team-reviewers` and `milestone`.
+
+1. Create a new GitHub user and login.
+2. Fork the repository that you will be creating pull requests in.
+3. Create a [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
+4. Logout and log back into your main user account.
+5. Add a secret to your repository containing the above PAT.
+6. As shown in the following example workflow, set the `push-to-fork` input to the full repository name of the fork.
+
+```yaml
+      - uses: actions/checkout@v3
+
+      # Make changes to pull request here
+
+      - uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.MACHINE_USER_PAT }}
+          push-to-fork: machine-user/fork-of-repository
+```
+
+### Authenticating with GitHub App generated tokens
+
+A GitHub App can be created for the sole purpose of generating tokens for use with GitHub actions.
+These tokens can be used in place of `GITHUB_TOKEN` or a [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
+GitHub App generated tokens are more secure than using a PAT because GitHub App access permissions can be set with finer granularity and are scoped to only repositories where the App is installed.
+
+1. Create a minimal [GitHub App](https://docs.github.com/en/developers/apps/creating-a-github-app), setting the following fields:
+
+    - Set `GitHub App name`.
+    - Set `Homepage URL` to anything you like, such as your GitHub profile page.
+    - Uncheck `Active` under `Webhook`. You do not need to enter a `Webhook URL`.
+    - Under `Repository permissions: Contents` select `Access: Read & write`.
+    - Under `Repository permissions: Pull requests` select `Access: Read & write`.
+    - Under `Organization permissions: Members` select `Access: Read-only`.
+      - **NOTE**: Only needed if you would like add teams as reviewers to PRs.
+
+2. Create a Private key from the App settings page and store it securely.
+
+3. Install the App on any repository where workflows will run requiring tokens.
+
+4. Set secrets on your repository containing the GitHub App ID, and the private key you created in step 2. e.g. `APP_ID`, `APP_PRIVATE_KEY`.
+
+5. The following example workflow shows how to use [tibdex/github-app-token](https://github.com/tibdex/github-app-token) to generate a token for use with this action.
+
+```yaml
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: tibdex/github-app-token@v1
+        id: generate-token
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+```
+
+### GPG commit signature verification
+
+The action can use GPG to sign commits with a GPG key that you generate yourself.
+
+1. Follow GitHub's guide to [generate a new GPG key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key).
+
+2. [Add the public key](https://docs.github.com/en/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account) to the user account associated with the [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) that you will use with the action.
+
+3. Copy the private key to your clipboard, replacing `email@example.com` with the email address of your GPG key.
+   ```
+   # macOS
+   gpg --armor --export-secret-key email@example.com | pbcopy
+   ```
+
+4. Paste the private key into a repository secret where the workflow will run. e.g. `GPG_PRIVATE_KEY`
+
+5. Create another repository secret for the key's passphrase, if applicable. e.g. `GPG_PASSPHRASE`
+
+6. The following example workflow shows how to use [crazy-max/ghaction-import-gpg](https://github.com/crazy-max/ghaction-import-gpg) to import your GPG key and allow the action to sign commits.
+
+   Note that the `committer` email address *MUST* match the email address used to create your GPG key.
+
+```yaml
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: crazy-max/ghaction-import-gpg@v3
+        with:
+          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.GPG_PASSPHRASE }}
+          git-user-signingkey: true
+          git-commit-gpgsign: true
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.PAT }}
+          committer: example <email@example.com>
+```
+
+### Running in a container or on self-hosted runners
+
+This action can be run inside a container, or on [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners), by installing the necessary dependencies.
+
+This action requires `git` to be installed and on the `PATH`. Note that `actions/checkout` requires Git 2.18 or higher to be installed, otherwise it will just download the source of the repository instead of cloning it.
+
+The following examples of running in a container show the dependencies being installed during the workflow, but they could also be pre-installed in a custom image.
+
+**Alpine container example:**
+```yml
+jobs:
+  createPullRequestAlpine:
+    runs-on: ubuntu-latest
+    container:
+      image: alpine
+    steps:
+      - name: Install dependencies
+        run: apk --no-cache add git
+
+      - uses: actions/checkout@v3
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+```
+
+**Ubuntu container example:**
+```yml
+jobs:
+  createPullRequestAlpine:
+    runs-on: ubuntu-latest
+    container:
+      image: ubuntu
+    steps:
+      - name: Install dependencies
+        run: |
+          apt-get update
+          apt-get install -y software-properties-common
+          add-apt-repository -y ppa:git-core/ppa
+          apt-get install -y git
+
+      - uses: actions/checkout@v3
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+```

docs/examples.md

@@ -0,0 +1,634 @@
+# Examples
+
+- [Use case: Create a pull request to update X on push](#use-case-create-a-pull-request-to-update-x-on-push)
+  - [Update project authors](#update-project-authors)
+  - [Keep a branch up-to-date with another](#keep-a-branch-up-to-date-with-another)
+- [Use case: Create a pull request to update X on release](#use-case-create-a-pull-request-to-update-x-on-release)
+  - [Update changelog](#update-changelog)
+- [Use case: Create a pull request to update X periodically](#use-case-create-a-pull-request-to-update-x-periodically)
+  - [Update NPM dependencies](#update-npm-dependencies)
+  - [Update Gradle dependencies](#update-gradle-dependencies)
+  - [Update Cargo dependencies](#update-cargo-dependencies)
+  - [Update SwaggerUI for GitHub Pages](#update-swaggerui-for-github-pages)
+  - [Keep a fork up-to-date with its upstream](#keep-a-fork-up-to-date-with-its-upstream)
+  - [Spider and download a website](#spider-and-download-a-website)
+- [Use case: Create a pull request to update X by calling the GitHub API](#use-case-create-a-pull-request-to-update-x-by-calling-the-github-api)
+  - [Call the GitHub API from an external service](#call-the-github-api-from-an-external-service)
+  - [Call the GitHub API from another GitHub Actions workflow](#call-the-github-api-from-another-github-actions-workflow)
+- [Use case: Create a pull request to modify/fix pull requests](#use-case-create-a-pull-request-to-modifyfix-pull-requests)
+  - [autopep8](#autopep8)
+- [Misc workflow tips](#misc-workflow-tips)
+  - [Filtering push events](#filtering-push-events)
+  - [Dynamic configuration using variables](#dynamic-configuration-using-variables)
+  - [Setting the pull request body from a file](#setting-the-pull-request-body-from-a-file)
+  - [Using a markdown template](#using-a-markdown-template)
+  - [Debugging GitHub Actions](#debugging-github-actions)
+
+
+## Use case: Create a pull request to update X on push
+
+This pattern will work well for updating any kind of static content based on pushed changes. Care should be taken when using this pattern in repositories with a high frequency of commits.
+
+### Update project authors
+
+Raises a pull request to update a file called `AUTHORS` with the git user names and email addresses of contributors.
+
+```yml
+name: Update AUTHORS
+on:
+  push:
+    branches:
+      - main
+jobs:
+  updateAuthors:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Update AUTHORS
+        run: |
+          git log --format='%aN <%aE>%n%cN <%cE>' | sort -u > AUTHORS
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: update authors
+          title: Update AUTHORS
+          body: Credit new contributors by updating AUTHORS
+          branch: update-authors
+```
+
+### Keep a branch up-to-date with another
+
+This is a use case where a branch should be kept up to date with another by opening a pull request to update it. The pull request should then be updated with new changes until it is merged or closed.
+
+In this example scenario, a branch called `production` should be updated via pull request to keep it in sync with `main`. Merging the pull request is effectively promoting those changes to production.
+
+```yml
+name: Create production promotion pull request
+on:
+  push:
+    branches:
+      - main
+jobs:
+  productionPromotion:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: production
+      - name: Reset promotion branch
+        run: |
+          git fetch origin main:main
+          git reset --hard main
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          branch: production-promotion
+```
+
+## Use case: Create a pull request to update X on release
+
+This pattern will work well for updating any kind of static content based on the tagged commit of a release. Note that because `release` is one of the [events which checkout a commit](concepts-guidelines.md#events-which-checkout-a-commit) it is necessary to supply the `base` input to the action.
+
+### Update changelog
+
+Raises a pull request to update the `CHANGELOG.md` file based on the tagged commit of the release.
+Note that [git-chglog](https://github.com/git-chglog/git-chglog/) requires some configuration files to exist in the repository before this workflow will work.
+
+This workflow assumes the tagged release was made on a default branch called `main`.
+
+```yml
+name: Update Changelog
+on:
+  release:
+    types: [published]
+jobs:
+  updateChangelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Update Changelog
+        run: |
+          curl -o git-chglog -L https://github.com/git-chglog/git-chglog/releases/download/0.9.1/git-chglog_linux_amd64
+          chmod u+x git-chglog
+          ./git-chglog -o CHANGELOG.md
+          rm git-chglog
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: update changelog
+          title: Update Changelog
+          body: Update changelog to reflect release changes
+          branch: update-changelog
+          base: main
+```
+
+## Use case: Create a pull request to update X periodically
+
+This pattern will work well for updating any kind of static content from an external source. The workflow executes on a schedule and raises a pull request when there are changes.
+
+### Update NPM dependencies
+
+This workflow will create a pull request for npm dependencies.
+It works best in combination with a build workflow triggered on `push` and `pull_request`.
+A [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) can be used in order for the creation of the pull request to trigger further workflows. See the [documentation here](concepts-guidelines.md#triggering-further-workflow-runs) for further details.
+
+```yml
+name: Update Dependencies
+on:
+  schedule:
+    - cron:  '0 10 * * 1'
+jobs:
+  update-dep:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - name: Update dependencies
+        run: |
+          npx -p npm-check-updates ncu -u
+          npm install
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+            token: ${{ secrets.PAT }}
+            commit-message: Update dependencies
+            title: Update dependencies
+            body: |
+              - Dependency updates
+  
+              Auto-generated by [create-pull-request][1]
+  
+              [1]: https://github.com/peter-evans/create-pull-request
+            branch: update-dependencies
+```
+
+The above workflow works best in combination with a build workflow triggered on `push` and `pull_request`.
+
+```yml
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - run: npm ci
+      - run: npm run test
+      - run: npm run build
+```
+
+### Update Gradle dependencies
+
+The following workflow will create a pull request for Gradle dependencies.
+It requires first configuring your project to use Gradle lockfiles.
+See [here](https://github.com/peter-evans/gradle-auto-dependency-updates) for how to configure your project and use the following workflow.
+
+```yml
+name: Update Dependencies
+on:
+  schedule:
+    - cron:  '0 1 * * 1'
+jobs:
+  update-dep:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v2
+        with:
+          distribution: 'temurin'
+          java-version: 1.8
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Perform dependency resolution and write new lockfiles
+        run: ./gradlew dependencies --write-locks
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+            token: ${{ secrets.PAT }}
+            commit-message: Update dependencies
+            title: Update dependencies
+            body: |
+              - Dependency updates
+  
+              Auto-generated by [create-pull-request][1]
+  
+              [1]: https://github.com/peter-evans/create-pull-request
+            branch: update-dependencies
+```
+
+### Update Cargo dependencies
+
+The following workflow will create a pull request for Cargo dependencies.
+It optionally uses [`cargo-edit`](https://github.com/killercup/cargo-edit) to update `Cargo.toml` and keep it in sync with `Cargo.lock`.
+
+```yml
+name: Update Dependencies
+on:
+  schedule:
+    - cron:  '0 1 * * 1'
+jobs:
+  update-dep:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update dependencies
+        run: |
+          cargo install cargo-edit
+          cargo update
+          cargo upgrade --to-lockfile
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+            token: ${{ secrets.PAT }}
+            commit-message: Update dependencies
+            title: Update dependencies
+            body: |
+              - Dependency updates
+  
+              Auto-generated by [create-pull-request][1]
+  
+              [1]: https://github.com/peter-evans/create-pull-request
+            branch: update-dependencies
+```
+
+### Update SwaggerUI for GitHub Pages
+
+When using [GitHub Pages to host Swagger documentation](https://github.com/peter-evans/swagger-github-pages), this workflow updates the repository with the latest distribution of [SwaggerUI](https://github.com/swagger-api/swagger-ui).
+
+You must create a file called `swagger-ui.version` at the root of your repository before running.
+```yml
+name: Update Swagger UI
+on:
+  schedule:
+    - cron:  '0 10 * * *'
+jobs:
+  updateSwagger:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Get Latest Swagger UI Release
+        id: swagger-ui
+        run: |
+          release_tag=$(curl -sL https://api.github.com/repos/swagger-api/swagger-ui/releases/latest | jq -r ".tag_name")
+          echo "release_tag=$release_tag" >> $GITHUB_OUTPUT
+          current_tag=$(<swagger-ui.version)
+          echo "current_tag=$current_tag" >> $GITHUB_OUTPUT
+      - name: Update Swagger UI
+        if: steps.swagger-ui.outputs.current_tag != steps.swagger-ui.outputs.release_tag
+        env:
+          RELEASE_TAG: ${{ steps.swagger-ui.outputs.release_tag }}
+          SWAGGER_YAML: "swagger.yaml"
+        run: |
+          # Delete the dist directory and index.html
+          rm -fr dist index.html
+          # Download the release
+          curl -sL -o $RELEASE_TAG https://api.github.com/repos/swagger-api/swagger-ui/tarball/$RELEASE_TAG
+          # Extract the dist directory
+          tar -xzf $RELEASE_TAG --strip-components=1 $(tar -tzf $RELEASE_TAG | head -1 | cut -f1 -d"/")/dist
+          rm $RELEASE_TAG
+          # Move index.html to the root
+          mv dist/index.html .
+          # Fix references in index.html
+          sed -i "s|https://petstore.swagger.io/v2/swagger.json|$SWAGGER_YAML|g" index.html
+          sed -i "s|href=\"./|href=\"dist/|g" index.html
+          sed -i "s|src=\"./|src=\"dist/|g" index.html
+          # Update current release
+          echo ${{ steps.swagger-ui.outputs.release_tag }} > swagger-ui.version
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: Update swagger-ui to ${{ steps.swagger-ui.outputs.release_tag }}
+          title: Update SwaggerUI to ${{ steps.swagger-ui.outputs.release_tag }}
+          body: |
+            Updates [swagger-ui][1] to ${{ steps.swagger-ui.outputs.release_tag }}
+
+            Auto-generated by [create-pull-request][2]
+
+            [1]: https://github.com/swagger-api/swagger-ui
+            [2]: https://github.com/peter-evans/create-pull-request
+          labels: dependencies, automated pr
+          branch: swagger-ui-updates
+```
+
+### Keep a fork up-to-date with its upstream
+
+This example is designed to be run in a seperate repository from the fork repository itself.
+The aim of this is to prevent committing anything to the fork's default branch would cause it to differ from the upstream.
+
+In the following example workflow, `owner/repo` is the upstream repository and `fork-owner/repo` is the fork. It assumes the default branch of the upstream repository is called `main`.
+
+The [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) should have `repo` scope. Additionally, if the upstream makes changes to the `.github/workflows` directory, the action will be unable to push the changes to a branch and throw the error "_(refusing to allow a GitHub App to create or update workflow `.github/workflows/xxx.yml` without `workflows` permission)_". To allow these changes to be pushed to the fork, add the `workflow` scope to the PAT. Of course, allowing this comes with the risk that the workflow changes from the upstream could run and do something unexpected. Disabling GitHub Actions in the fork is highly recommended to prevent this.
+
+When you merge the pull request make sure to choose the [`Rebase and merge`](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#rebase-and-merge-your-pull-request-commits) option. This will make the fork's commits match the commits on the upstream.
+
+```yml
+name: Update fork
+on:
+  schedule:
+    - cron:  '0 0 * * 0'
+jobs:
+  updateFork:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: fork-owner/repo
+      - name: Reset the default branch with upstream changes
+        run: |
+          git remote add upstream https://github.com/owner/repo.git
+          git fetch upstream main:upstream-main
+          git reset --hard upstream-main
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.PAT }}
+          branch: upstream-changes
+```
+
+### Spider and download a website
+
+This workflow spiders a website and downloads the content. Any changes to the website will be raised in a pull request.
+
+```yml
+name: Download Website
+on:
+  schedule:
+    - cron:  '0 10 * * *'
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download website
+        run: |
+          wget \
+            --recursive \
+            --level=2 \
+            --wait=1 \
+            --no-clobber \
+            --page-requisites \
+            --html-extension \
+            --convert-links \
+            --domains quotes.toscrape.com \
+            http://quotes.toscrape.com/
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: update local website copy
+          title: Automated Updates to Local Website Copy
+          body: This is an auto-generated PR with website updates.
+          branch: website-updates
+```
+
+## Use case: Create a pull request to update X by calling the GitHub API
+
+You can use the GitHub API to trigger a webhook event called [`repository_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch) when you want to trigger a workflow for any activity that happens outside of GitHub.
+This pattern will work well for updating any kind of static content from an external source.
+
+You can modify any of the examples in the previous section to work in this fashion.
+
+Set the workflow to execute `on: repository_dispatch`.
+
+```yml
+on:
+  repository_dispatch:
+    types: [create-pull-request]
+```
+
+### Call the GitHub API from an external service
+
+An `on: repository_dispatch` workflow can be triggered by a call to the GitHub API as follows.
+
+- `[username]` is a GitHub username
+- `[token]` is a `repo` scoped [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
+- `[repository]` is the name of the repository the workflow resides in.
+
+```
+curl -XPOST -u "[username]:[token]" \
+  -H "Accept: application/vnd.github.everest-preview+json" \
+  -H "Content-Type: application/json" \
+  https://api.github.com/repos/[username]/[repository]/dispatches \
+  --data '{"event_type": "create-pull-request"}'
+```
+
+### Call the GitHub API from another GitHub Actions workflow
+
+An `on: repository_dispatch` workflow can be triggered from another workflow with [repository-dispatch](https://github.com/peter-evans/repository-dispatch) action.
+
+```yml
+- name: Repository Dispatch
+  uses: peter-evans/repository-dispatch@v2
+  with:
+    token: ${{ secrets.REPO_ACCESS_TOKEN }}
+    repository: username/my-repo
+    event-type: create-pull-request
+    client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+```
+
+## Use case: Create a pull request to modify/fix pull requests
+
+**Note**: While the following approach does work, my strong recommendation would be to use a slash command style "ChatOps" solution for operations on pull requests. See [slash-command-dispatch](https://github.com/peter-evans/slash-command-dispatch) for such a solution.
+
+This is a pattern that lends itself to automated code linting and fixing. A pull request can be created to fix or modify something during an `on: pull_request` workflow. The pull request containing the fix will be raised with the original pull request as the base. This can be then be merged to update the original pull request and pass any required tests.
+
+Note that due to [token restrictions on public repository forks](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token), workflows for this use case do not work for pull requests raised from forks.
+Private repositories can be configured to [enable workflows](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) from forks to run without restriction. 
+
+### autopep8
+
+The following is an example workflow for a use case where [autopep8 action](https://github.com/peter-evans/autopep8) runs as both a check on pull requests and raises a further pull request to apply code fixes.
+
+How it works:
+
+1. When a pull request is raised the workflow executes as a check
+2. If autopep8 makes any fixes a pull request will be raised for those fixes to be merged into the current pull request branch. The workflow then deliberately causes the check to fail.
+3. When the pull request containing the fixes is merged the workflow runs again. This time autopep8 makes no changes and the check passes.
+4. The original pull request can now be merged.
+
+```yml
+name: autopep8
+on: pull_request
+jobs:
+  autopep8:
+    # Check if the PR is not raised by this workflow and is not from a fork
+    if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+      - name: autopep8
+        id: autopep8
+        uses: peter-evans/autopep8@v1
+        with:
+          args: --exit-code --recursive --in-place --aggressive --aggressive .
+      - name: Set autopep8 branch name
+        id: vars
+        run: |
+          branch-name="autopep8-patches/${{ github.head_ref }}"
+          echo "branch-name=$branch-name" >> $GITHUB_OUTPUT
+      - name: Create Pull Request
+        if: steps.autopep8.outputs.exit-code == 2
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: autopep8 action fixes
+          title: Fixes by autopep8 action
+          body: This is an auto-generated PR with fixes by autopep8.
+          labels: autopep8, automated pr
+          branch: ${{ steps.vars.outputs.branch-name }}
+      - name: Fail if autopep8 made changes
+        if: steps.autopep8.outputs.exit-code == 2
+        run: exit 1
+```
+
+## Misc workflow tips
+
+### Filtering push events
+
+For workflows using `on: push` you may want to ignore push events for tags and only execute for branches. Specifying `branches` causes only events on branches to trigger the workflow. The `'**'` wildcard will match any branch name.
+
+```yml
+on:
+  push:
+    branches:
+      - '**' 
+```
+
+If you have a workflow that contains jobs to handle push events on branches as well as tags, you can make sure that the job where you use `create-pull-request` action only executes when `github.ref` is a branch by using an `if` condition as follows.
+
+```yml
+on: push
+jobs:
+  createPullRequest:
+    if: startsWith(github.ref, 'refs/heads/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      ...
+
+  someOtherJob:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      ...
+```
+
+### Dynamic configuration using variables
+
+The following examples show how configuration for the action can be dynamically defined in a previous workflow step.
+Note that the step where output variables are defined must have an id.
+
+```yml
+      - name: Set output variables
+        id: vars
+        run: |
+          pr_title="[Test] Add report file $(date +%d-%m-%Y)"
+          pr_body="This PR was auto-generated on $(date +%d-%m-%Y) \
+            by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
+          echo "pr_title=$pr_title" >> $GITHUB_OUTPUT
+          echo "pr_body=$pr_body" >> $GITHUB_OUTPUT
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          title: ${{ steps.vars.outputs.pr_title }}
+          body: ${{ steps.vars.outputs.pr_body }}
+```
+
+### Setting the pull request body from a file
+
+This example shows how file content can be read into a variable and passed to the action.
+
+```yml
+      - id: get-pr-body
+        run: |
+          body=$(cat pr-body.txt)
+          delimiter="$(openssl rand -hex 8)"
+          echo "body<<$delimiter" >> $GITHUB_OUTPUT
+          echo "$body" >> $GITHUB_OUTPUT
+          echo "$delimiter" >> $GITHUB_OUTPUT
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          body: ${{ steps.get-pr-body.outputs.body }}
+```
+
+### Using a markdown template
+
+In this example, a markdown template file is added to the repository at `.github/pull-request-template.md` with the following content.
+```
+This is a test pull request template
+Render template variables such as {{ .foo }} and {{ .bar }}.
+```
+
+The template is rendered using the [render-template](https://github.com/chuhlomin/render-template) action and the result is used to create the pull request.
+```yml
+      - name: Render template
+        id: template
+        uses: chuhlomin/render-template@v1.4
+        with:
+          template: .github/pull-request-template.md
+          vars: |
+            foo: this
+            bar: that
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          body: ${{ steps.template.outputs.result }}
+```
+
+### Debugging GitHub Actions
+
+#### Runner Diagnostic Logging
+
+[Runner diagnostic logging](https://docs.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run#enabling-runner-diagnostic-logging) provides additional log files that contain information about how a runner is executing an action.
+To enable runner diagnostic logging, set the secret `ACTIONS_RUNNER_DEBUG` to `true` in the repository that contains the workflow.
+
+#### Step Debug Logging
+
+[Step debug logging](https://docs.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run#enabling-step-debug-logging) increases the verbosity of a job's logs during and after a job's execution.
+To enable step debug logging set the secret `ACTIONS_STEP_DEBUG` to `true` in the repository that contains the workflow.
+
+#### Output Various Contexts
+
+```yml
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - name: Dump job context
+        env:
+          JOB_CONTEXT: ${{ toJson(job) }}
+        run: echo "$JOB_CONTEXT"
+      - name: Dump steps context
+        env:
+          STEPS_CONTEXT: ${{ toJson(steps) }}
+        run: echo "$STEPS_CONTEXT"
+      - name: Dump runner context
+        env:
+          RUNNER_CONTEXT: ${{ toJson(runner) }}
+        run: echo "$RUNNER_CONTEXT"
+      - name: Dump strategy context
+        env:
+          STRATEGY_CONTEXT: ${{ toJson(strategy) }}
+        run: echo "$STRATEGY_CONTEXT"
+      - name: Dump matrix context
+        env:
+          MATRIX_CONTEXT: ${{ toJson(matrix) }}
+        run: echo "$MATRIX_CONTEXT"
+```

docs/updating.md

@@ -0,0 +1,87 @@
+## Updating from `v3` to `v4`
+
+### Breaking changes
+
+- The `add-paths` input no longer accepts `-A` as a valid value. When committing all new and modified files the `add-paths` input should be omitted.
+
+- If using self-hosted runners or GitHub Enterprise Server, there are minimum requirements for `v4` to run. See "What's new" below for details.
+
+### What's new
+
+- Updated runtime to Node.js 16
+  - The action now requires a minimum version of v2.285.0 for the [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0).
+  - If using GitHub Enterprise Server, the action requires [GHES 3.4](https://docs.github.com/en/enterprise-server@3.4/admin/release-notes) or later.
+
+## Updating from `v2` to `v3`
+
+### Breaking changes
+
+- The `author` input now defaults to the user who triggered the workflow run. This default is set via [action.yml](../action.yml) as `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>`, where `github.actor` is the GitHub user account associated with the run. For example, `peter-evans <peter-evans@users.noreply.github.com>`.
+
+  To continue to use the `v2` default, set the `author` input as follows.
+  ```yaml
+      - uses: peter-evans/create-pull-request@v3
+        with:
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+  ```
+
+- The `author` and `committer` inputs are no longer cross-used if only one is supplied. Additionally, when neither input is set, the `author` and `committer` are no longer determined from an existing identity set in git config. In both cases, the inputs will fall back to their default set in [action.yml](../action.yml).
+
+- Deprecated inputs `project` and `project-column` have been removed in favour of an additional action step. See [Create a project card](https://github.com/peter-evans/create-pull-request#create-a-project-card) for details.
+
+- Deprecated output `pr_number` has been removed in favour of `pull-request-number`.
+
+- Input `request-to-parent` has been removed in favour of `push-to-fork`. This greatly simplifies pushing the pull request branch to a fork of the parent repository. See [Push pull request branches to a fork](concepts-guidelines.md#push-pull-request-branches-to-a-fork) for details.
+
+  e.g.
+  ```yaml
+      - uses: actions/checkout@v2
+
+      # Make changes to pull request here
+
+      - uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.MACHINE_USER_PAT }}
+          push-to-fork: machine-user/fork-of-repository
+  ```
+
+### What's new
+
+- The action has been converted to Typescript giving it a significant performance improvement.
+
+- If you run this action in a container, or on [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners), `python` and `pip` are no longer required dependencies. See [Running in a container or on self-hosted runners](concepts-guidelines.md#running-in-a-container-or-on-self-hosted-runners) for details.
+
+- Inputs `labels`, `assignees`, `reviewers` and `team-reviewers` can now be newline separated, or comma separated.
+  e.g.
+  ```yml
+          labels: |
+            chore
+            dependencies
+            automated
+  ```
+
+## Updating from `v1` to `v2`
+
+### Breaking changes
+
+- `v2` now expects repositories to be checked out with `actions/checkout@v2`
+
+  To use `actions/checkout@v1` the following step to checkout the branch is necessary.
+  ```yml
+      - uses: actions/checkout@v1
+      - name: Checkout branch
+        run: git checkout "${GITHUB_REF:11}"
+  ```
+
+- The two branch naming strategies have been swapped. Fixed-branch naming strategy is now the default. i.e. `branch-suffix: none` is now the default and should be removed from configuration if set.
+
+- `author-name`, `author-email`, `committer-name`, `committer-email` have been removed in favour of `author` and `committer`.
+  They can both be set in the format `Display Name <email@address.com>`
+
+  If neither `author` or `committer` are set the action will default to making commits as the GitHub Actions bot user.
+
+### What's new
+
+- Unpushed commits made during the workflow before the action runs will now be considered as changes to be raised in the pull request. See [Create your own commits](https://github.com/peter-evans/create-pull-request#create-your-own-commits) for details.
+- New commits made to the pull request base will now be taken into account when pull requests are updated.
+- If an updated pull request no longer differs from its base it will automatically be closed and the pull request branch deleted.

examples.md

@@ -1,310 +0,0 @@
-# Examples
-
-- [Use case: Create a pull request to update X periodically](#use-case-create-a-pull-request-to-update-x-periodically)
-  - [Update NPM dependencies](#update-npm-dependencies)
-  - [Keep Go up to date](#keep-go-up-to-date)
-  - [Spider and download a website](#spider-and-download-a-website)
-- [Use case: Create a pull request to update X by calling the GitHub API](#use-case-create-a-pull-request-to-update-x-by-calling-the-github-api)
-  - [Call the GitHub API from an external service](#call-the-github-api-from-an-external-service)
-  - [Call the GitHub API from another GitHub Actions workflow](#call-the-github-api-from-another-github-actions-workflow)
-- [Use case: Create a pull request to modify/fix pull requests](#use-case-create-a-pull-request-to-modifyfix-pull-requests)
-  - [autopep8](#autopep8)
-- [Misc workflow tips](#misc-workflow-tips)
-  - [Filtering push events](#filtering-push-events)
-  - [Dynamic configuration using variables](#dynamic-configuration-using-variables)
-  - [Debugging GitHub Actions](#debugging-github-actions)
-
-
-## Use case: Create a pull request to update X periodically
-
-This pattern will work well for updating any kind of static content from an external source. The workflow executes on a schedule and raises a pull request when there are changes.
-
-### Update NPM dependencies
-
-```yml
-name: Update Dependencies
-on:
-  schedule:
-    - cron:  '0 10 * * 1'
-jobs:
-  update-deps:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '10.x'
-      - name: Update dependencies
-        id: vars
-        run: |
-          npm install -g npm-check-updates
-          ncu -u
-          npm install
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: update dependencies
-          title: Automated Dependency Updates
-          body: This is an auto-generated PR with dependency updates.
-          branch: dep-updates
-          branch-suffix: none
-```
-
-### Keep Go up to date
-
-Keep Go up to date with [ensure-latest-go](https://github.com/jmhodges/ensure-latest-go) action.
-
-```yml
-name: Keeping Go up to date
-on:
-  schedule:
-    - cron: 47 4 * * *
-  push:
-    branches:
-      - master
-jobs:
-  fresh_go:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-        with:
-          ref: master
-      - uses: jmhodges/ensure-latest-go@v1.0.2
-        id: ensure_go
-      - run: echo "##[set-output name=pr_title;]update to latest Go release ${{ steps.ensure_go.outputs.go_version}}"
-        id: pr_title_maker
-      - name: Create pull request
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          title: ${{ steps.pr_title_maker.outputs.pr_title }}
-          body: Auto-generated pull request created by the GitHub Actions [create-pull-request](https://github.com/peter-evans/create-pull-request) and [ensure-latest-go](https://github.com/jmhodges/ensure-latest-go).
-          commit-message: ${{ steps.pr_title_maker.outputs.pr_title }}
-          branch-suffix: none
-          branch: ensure-latest-go/patch-${{ steps.ensure_go.outputs.go_version }}
-```
-
-### Spider and download a website
-
-```yml
-name: Download Website
-on:
-  schedule:
-    - cron:  '0 10 * * *'
-jobs:
-  format:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: Download website
-        run: |
-          wget \
-            --recursive \
-            --level=2 \
-            --wait=1 \
-            --no-clobber \
-            --page-requisites \
-            --html-extension \
-            --convert-links \
-            --domains quotes.toscrape.com \
-            http://quotes.toscrape.com/
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: update local website copy
-          title: Automated Updates to Local Website Copy
-          body: This is an auto-generated PR with website updates.
-          branch: website-updates
-          branch-suffix: none
-```
-
-## Use case: Create a pull request to update X by calling the GitHub API
-
-You can use the GitHub API to trigger a webhook event called [`repository_dispatch`](https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#external-events-repository_dispatch) when you want to trigger a workflow for activity that happens outside of GitHub.
-This pattern will work well for updating any kind of static content from an external source.
-
-You can modify any of the examples in the previous section to work in this fashion.
-
-Set the workflow to execute `on: repository_dispatch`.
-
-```yml
-on:
-  repository_dispatch:
-    types: [create-pull-request]
-```
-
-### Call the GitHub API from an external service
-
-An `on: repository_dispatch` workflow can be triggered by a call to the GitHub API as follows.
-
-- `[username]` is a GitHub username
-- `[token]` is a `repo` scoped [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
-- `[repository]` is the name of the repository the workflow resides in.
-
-```
-curl -XPOST -u "[username]:[token]" \
-  -H "Accept: application/vnd.github.everest-preview+json" \
-  -H "Content-Type: application/json" \
-  https://api.github.com/repos/[username]/[repository]/dispatches \
-  --data '{"event_type": "create-pull-request"}'
-```
-
-### Call the GitHub API from another GitHub Actions workflow
-
-An `on: repository_dispatch` workflow can be triggered from another workflow with [repository-dispatch](https://github.com/peter-evans/repository-dispatch) action.
-
-```yml
-- name: Repository Dispatch
-  uses: peter-evans/repository-dispatch@v1.0.0
-  with:
-    token: ${{ secrets.REPO_ACCESS_TOKEN }}
-    repository: username/my-repo
-    event-type: create-pull-request
-    client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
-```
-
-## Use case: Create a pull request to modify/fix pull requests
-
-This is a pattern that works well for any automated code linting and fixing. A pull request can be created to fix or modify something during an `on: pull_request` workflow. The pull request containing the fix will be raised with the original pull request as the base. This can be then be merged to update the original pull request and pass any required tests.
-
-Note that due to [limitations on forked repositories](https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#token-permissions) workflows for this use case do not work for pull requests raised from forks.
-
-### autopep8
-
-The following is an example workflow for a use case where [autopep8 action](https://github.com/peter-evans/autopep8) runs as both a check on pull requests and raises a further pull request to apply code fixes.
-
-How it works:
-
-1. When a pull request is raised the workflow executes as a check
-2. If autopep8 makes any fixes a pull request will be raised for those fixes to be merged into the current pull request branch. The workflow then deliberately causes the check to fail.
-3. When the pull request containing the fixes is merged the workflow runs again. This time autopep8 makes no changes and the check passes.
-4. The original pull request can now be merged.
-
-```yml
-name: autopep8
-on: pull_request
-jobs:
-  autopep8:
-    # Check if the PR is not raised by this workflow and is not from a fork
-    if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: autopep8
-        id: autopep8
-        uses: peter-evans/autopep8@v1.1.0
-        with:
-          args: --exit-code --recursive --in-place --aggressive --aggressive .
-      - name: Set autopep8 branch name
-        id: vars
-        run: echo ::set-output name=branch-name::"autopep8-patches/$GITHUB_HEAD_REF"
-      - name: Create Pull Request
-        if: steps.autopep8.outputs.exit-code == 2
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: autopep8 action fixes
-          title: Fixes by autopep8 action
-          body: This is an auto-generated PR with fixes by autopep8.
-          labels: autopep8, automated pr
-          branch: ${{ steps.vars.outputs.branch-name }}
-          branch-suffix: none
-      - name: Fail if autopep8 made changes
-        if: steps.autopep8.outputs.exit-code == 2
-        run: exit 1
-```
-
-## Misc workflow tips
-
-### Filtering push events
-
-For workflows using `on: push` you may want to ignore push events for tags and remotes.
-These can be filtered out with the following `if` condition.
-
-```yml
-name: Create Pull Request
-on: push
-jobs:
-  createPullRequest:
-    if: startsWith(github.ref, 'refs/heads/')
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      ...
-```
-
-### Dynamic configuration using variables
-
-The following examples show how configuration for the action can be dynamically defined in a previous workflow step.
-
-The recommended method is to use [`set-output`](https://help.github.com/en/github/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-an-output-parameter-set-output). Note that the step where output variables are defined must have an id.
-
-```yml
-      - name: Set output variables
-        id: vars
-        run: |
-          echo ::set-output name=pr_title::"[Test] Add report file $(date +%d-%m-%Y)"
-          echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \
-            by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          title: ${{ steps.vars.outputs.pr_title }}
-          body: ${{ steps.vars.outputs.pr_body }}
-```
-
-Alternatively, [`set-env`](https://help.github.com/en/github/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-an-environment-variable-set-env) can be used to create environment variables.
-
-```yml
-      - name: Set environment variables
-        run: |
-          echo ::set-env name=PULL_REQUEST_TITLE::"[Test] Add report file $(date +%d-%m-%Y)"
-          echo ::set-env name=PULL_REQUEST_BODY::"This PR was auto-generated on $(date +%d-%m-%Y) \
-            by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.7.1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          title: ${{ env.PULL_REQUEST_TITLE }}
-          body: ${{ env.PULL_REQUEST_BODY }}
-```
-
-### Debugging GitHub Actions
-
-**Step Debug Logging** : To enable step debug logging set the secret `ACTIONS_STEP_DEBUG` to `true` in the repository that contains the workflow.
-
-**Output Various Contexts**
-
-```yml
-      - name: Dump event JSON
-        env:
-          EVENT_JSON_FILENAME: ${{ github.event_path }}
-        run: cat "$EVENT_JSON_FILENAME"
-      - name: Dump GitHub context
-        env:
-          GITHUB_CONTEXT: ${{ toJson(github) }}
-        run: echo "$GITHUB_CONTEXT"
-      - name: Dump job context
-        env:
-          JOB_CONTEXT: ${{ toJson(job) }}
-        run: echo "$JOB_CONTEXT"
-      - name: Dump steps context
-        env:
-          STEPS_CONTEXT: ${{ toJson(steps) }}
-        run: echo "$STEPS_CONTEXT"
-      - name: Dump runner context
-        env:
-          RUNNER_CONTEXT: ${{ toJson(runner) }}
-        run: echo "$RUNNER_CONTEXT"
-      - name: Dump strategy context
-        env:
-          STRATEGY_CONTEXT: ${{ toJson(strategy) }}
-        run: echo "$STRATEGY_CONTEXT"
-      - name: Dump matrix context
-        env:
-          MATRIX_CONTEXT: ${{ toJson(matrix) }}
-        run: echo "$MATRIX_CONTEXT"
-```

index.js

@@ -1,66 +0,0 @@
-const { inspect } = require("util");
-const core = require("@actions/core");
-const exec = require("@actions/exec");
-const setupPython = require("./src/setup-python");
-
-async function run() {
-  try {
-    // Allows ncc to find assets to be included in the distribution
-    const src = __dirname + "/src";
-    core.debug(`src: ${src}`);
-
-    // Setup Python from the tool cache
-    setupPython("3.8.0", "x64");
-
-    // Install requirements
-    await exec.exec("pip", [
-      "install",
-      "--requirement",
-      `${src}/requirements.txt`
-    ]);
-
-    // Fetch action inputs
-    const inputs = {
-      token: core.getInput("token"),
-      commitMessage: core.getInput("commit-message"),
-      commitAuthorEmail: core.getInput("author-email"),
-      commitAuthorName: core.getInput("author-name"),
-      title: core.getInput("title"),
-      body: core.getInput("body"),
-      labels: core.getInput("labels"),
-      assignees: core.getInput("assignees"),
-      reviewers: core.getInput("reviewers"),
-      teamReviewers: core.getInput("team-reviewers"),
-      milestone: core.getInput("milestone"),
-      branch: core.getInput("branch"),
-      base: core.getInput("base"),
-      branchSuffix: core.getInput("branch-suffix"),
-      debugEvent: core.getInput("debug-event")
-    };
-    core.debug(`Inputs: ${inspect(inputs)}`);
-
-    // Set environment variables from inputs.
-    if (inputs.token) process.env.GITHUB_TOKEN = inputs.token;
-    if (inputs.commitMessage) process.env.COMMIT_MESSAGE = inputs.commitMessage;
-    if (inputs.commitAuthorEmail) process.env.COMMIT_AUTHOR_EMAIL = inputs.commitAuthorEmail;
-    if (inputs.commitAuthorName) process.env.COMMIT_AUTHOR_NAME = inputs.commitAuthorName;
-    if (inputs.title) process.env.PULL_REQUEST_TITLE = inputs.title;
-    if (inputs.body) process.env.PULL_REQUEST_BODY = inputs.body;
-    if (inputs.labels) process.env.PULL_REQUEST_LABELS = inputs.labels;
-    if (inputs.assignees) process.env.PULL_REQUEST_ASSIGNEES = inputs.assignees;
-    if (inputs.reviewers) process.env.PULL_REQUEST_REVIEWERS = inputs.reviewers;
-    if (inputs.teamReviewers) process.env.PULL_REQUEST_TEAM_REVIEWERS = inputs.teamReviewers;
-    if (inputs.milestone) process.env.PULL_REQUEST_MILESTONE = inputs.milestone;
-    if (inputs.branch) process.env.PULL_REQUEST_BRANCH = inputs.branch;
-    if (inputs.base) process.env.PULL_REQUEST_BASE = inputs.base;
-    if (inputs.branchSuffix) process.env.BRANCH_SUFFIX = inputs.branchSuffix;
-    if (inputs.debugEvent) process.env.DEBUG_EVENT = inputs.debugEvent;
-
-    // Execute python script
-    await exec.exec("python", [`${src}/create-pull-request.py`]);
-  } catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run();

jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  clearMocks: true,
+  moduleFileExtensions: ['js', 'ts'],
+  testEnvironment: 'node',
+  testMatch: ['**/*.test.ts'],
+  testRunner: 'jest-circus/runner',
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  verbose: true
+}

package.json

@@ -1,16 +1,27 @@
 {
   "name": "create-pull-request",
-  "version": "1.7.1",
+  "version": "4.0.0",
+  "private": true,
   "description": "Creates a pull request for changes to your repository in the actions workspace",
-  "main": "index.js",
+  "main": "lib/main.js",
   "scripts": {
-    "build": "ncc build index.js -o dist"
+    "build": "tsc && ncc build",
+    "format": "prettier --write '**/*.ts'",
+    "format-check": "prettier --check '**/*.ts'",
+    "lint": "eslint src/**/*.ts",
+    "test:unit": "jest unit",
+    "test:int": "__test__/integration-tests.sh",
+    "test": "npm run test:unit && npm run test:int"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/peter-evans/create-pull-request.git"
   },
-  "keywords": [],
+  "keywords": [
+    "actions",
+    "pull",
+    "request"
+  ],
   "author": "Peter Evans",
   "license": "MIT",
   "bugs": {
@@ -18,11 +29,30 @@
   },
   "homepage": "https://github.com/peter-evans/create-pull-request",
   "dependencies": {
-    "@actions/core": "^1.1.1",
-    "@actions/exec": "^1.0.1",
-    "@actions/tool-cache": "^1.1.2"
+    "@actions/core": "^1.10.0",
+    "@actions/exec": "^1.1.1",
+    "@octokit/core": "^3.5.1",
+    "@octokit/plugin-paginate-rest": "^2.17.0",
+    "@octokit/plugin-rest-endpoint-methods": "^5.13.0",
+    "proxy-agent": "^5.0.0",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@zeit/ncc": "0.20.5"
+    "@types/jest": "^27.5.0",
+    "@types/node": "^16.11.11",
+    "@typescript-eslint/parser": "^5.5.0",
+    "@vercel/ncc": "^0.32.0",
+    "eslint": "^8.3.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-github": "^4.3.5",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^26.1.5",
+    "jest": "^28.1.0",
+    "jest-circus": "^28.1.0",
+    "jest-environment-jsdom": "^28.1.0",
+    "js-yaml": "^4.1.0",
+    "prettier": "^2.5.0",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.5.2"
   }
 }

renovate.json

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "config:base"
-  ]
-}

src/create-or-update-branch.ts

@@ -0,0 +1,294 @@
+import * as core from '@actions/core'
+import {GitCommandManager} from './git-command-manager'
+import {v4 as uuidv4} from 'uuid'
+
+const CHERRYPICK_EMPTY =
+  'The previous cherry-pick is now empty, possibly due to conflict resolution.'
+const NOTHING_TO_COMMIT = 'nothing to commit, working tree clean'
+
+export enum WorkingBaseType {
+  Branch = 'branch',
+  Commit = 'commit'
+}
+
+export async function getWorkingBaseAndType(
+  git: GitCommandManager
+): Promise<[string, WorkingBaseType]> {
+  const symbolicRefResult = await git.exec(
+    ['symbolic-ref', 'HEAD', '--short'],
+    true
+  )
+  if (symbolicRefResult.exitCode == 0) {
+    // A ref is checked out
+    return [symbolicRefResult.stdout.trim(), WorkingBaseType.Branch]
+  } else {
+    // A commit is checked out (detached HEAD)
+    const headSha = await git.revParse('HEAD')
+    return [headSha, WorkingBaseType.Commit]
+  }
+}
+
+export async function tryFetch(
+  git: GitCommandManager,
+  remote: string,
+  branch: string
+): Promise<boolean> {
+  try {
+    await git.fetch([`${branch}:refs/remotes/${remote}/${branch}`], remote, [
+      '--force'
+    ])
+    return true
+  } catch {
+    return false
+  }
+}
+
+// Return the number of commits that branch2 is ahead of branch1
+async function commitsAhead(
+  git: GitCommandManager,
+  branch1: string,
+  branch2: string
+): Promise<number> {
+  const result = await git.revList(
+    [`${branch1}...${branch2}`],
+    ['--right-only', '--count']
+  )
+  return Number(result)
+}
+
+// Return true if branch2 is ahead of branch1
+async function isAhead(
+  git: GitCommandManager,
+  branch1: string,
+  branch2: string
+): Promise<boolean> {
+  return (await commitsAhead(git, branch1, branch2)) > 0
+}
+
+// Return the number of commits that branch2 is behind branch1
+async function commitsBehind(
+  git: GitCommandManager,
+  branch1: string,
+  branch2: string
+): Promise<number> {
+  const result = await git.revList(
+    [`${branch1}...${branch2}`],
+    ['--left-only', '--count']
+  )
+  return Number(result)
+}
+
+// Return true if branch2 is behind branch1
+async function isBehind(
+  git: GitCommandManager,
+  branch1: string,
+  branch2: string
+): Promise<boolean> {
+  return (await commitsBehind(git, branch1, branch2)) > 0
+}
+
+// Return true if branch2 is even with branch1
+async function isEven(
+  git: GitCommandManager,
+  branch1: string,
+  branch2: string
+): Promise<boolean> {
+  return (
+    !(await isAhead(git, branch1, branch2)) &&
+    !(await isBehind(git, branch1, branch2))
+  )
+}
+
+function splitLines(multilineString: string): string[] {
+  return multilineString
+    .split('\n')
+    .map(s => s.trim())
+    .filter(x => x !== '')
+}
+
+export async function createOrUpdateBranch(
+  git: GitCommandManager,
+  commitMessage: string,
+  base: string,
+  branch: string,
+  branchRemoteName: string,
+  signoff: boolean,
+  addPaths: string[]
+): Promise<CreateOrUpdateBranchResult> {
+  // Get the working base.
+  // When a ref, it may or may not be the actual base.
+  // When a commit, we must rebase onto the actual base.
+  const [workingBase, workingBaseType] = await getWorkingBaseAndType(git)
+  core.info(`Working base is ${workingBaseType} '${workingBase}'`)
+  if (workingBaseType == WorkingBaseType.Commit && !base) {
+    throw new Error(`When in 'detached HEAD' state, 'base' must be supplied.`)
+  }
+
+  // If the base is not specified it is assumed to be the working base.
+  base = base ? base : workingBase
+  const baseRemote = 'origin'
+
+  // Set the default return values
+  const result: CreateOrUpdateBranchResult = {
+    action: 'none',
+    base: base,
+    hasDiffWithBase: false,
+    headSha: ''
+  }
+
+  // Save the working base changes to a temporary branch
+  const tempBranch = uuidv4()
+  await git.checkout(tempBranch, 'HEAD')
+  // Commit any uncommitted changes
+  if (await git.isDirty(true, addPaths)) {
+    core.info('Uncommitted changes found. Adding a commit.')
+    const aopts = ['add']
+    if (addPaths.length > 0) {
+      aopts.push(...['--', ...addPaths])
+    } else {
+      aopts.push('-A')
+    }
+    await git.exec(aopts, true)
+    const popts = ['-m', commitMessage]
+    if (signoff) {
+      popts.push('--signoff')
+    }
+    const commitResult = await git.commit(popts, true)
+    // 'nothing to commit' can occur when core.autocrlf is set to true
+    if (
+      commitResult.exitCode != 0 &&
+      !commitResult.stdout.includes(NOTHING_TO_COMMIT)
+    ) {
+      throw new Error(`Unexpected error: ${commitResult.stderr}`)
+    }
+  }
+
+  // Remove uncommitted tracked and untracked changes
+  await git.exec(['reset', '--hard'])
+  await git.exec(['clean', '-f', '-d'])
+
+  // Perform fetch and reset the working base
+  // Commits made during the workflow will be removed
+  if (workingBaseType == WorkingBaseType.Branch) {
+    core.info(`Resetting working base branch '${workingBase}'`)
+    if (branchRemoteName == 'fork') {
+      // If pushing to a fork we must fetch with 'unshallow' to avoid the following error on git push
+      // ! [remote rejected] HEAD -> tests/push-branch-to-fork (shallow update not allowed)
+      await git.fetch([`${workingBase}:${workingBase}`], baseRemote, [
+        '--force'
+      ])
+    } else {
+      // If the remote is 'origin' we can git reset
+      await git.checkout(workingBase)
+      await git.exec(['reset', '--hard', `${baseRemote}/${workingBase}`])
+    }
+  }
+
+  // If the working base is not the base, rebase the temp branch commits
+  // This will also be true if the working base type is a commit
+  if (workingBase != base) {
+    core.info(
+      `Rebasing commits made to ${workingBaseType} '${workingBase}' on to base branch '${base}'`
+    )
+    // Checkout the actual base
+    await git.fetch([`${base}:${base}`], baseRemote, ['--force'])
+    await git.checkout(base)
+    // Cherrypick commits from the temporary branch starting from the working base
+    const commits = await git.revList(
+      [`${workingBase}..${tempBranch}`, '.'],
+      ['--reverse']
+    )
+    for (const commit of splitLines(commits)) {
+      const result = await git.cherryPick(
+        ['--strategy=recursive', '--strategy-option=theirs', commit],
+        true
+      )
+      if (result.exitCode != 0 && !result.stderr.includes(CHERRYPICK_EMPTY)) {
+        throw new Error(`Unexpected error: ${result.stderr}`)
+      }
+    }
+    // Reset the temp branch to the working index
+    await git.checkout(tempBranch, 'HEAD')
+    // Reset the base
+    await git.fetch([`${base}:${base}`], baseRemote, ['--force'])
+  }
+
+  // Try to fetch the pull request branch
+  if (!(await tryFetch(git, branchRemoteName, branch))) {
+    // The pull request branch does not exist
+    core.info(`Pull request branch '${branch}' does not exist yet.`)
+    // Create the pull request branch
+    await git.checkout(branch, tempBranch)
+    // Check if the pull request branch is ahead of the base
+    result.hasDiffWithBase = await isAhead(git, base, branch)
+    if (result.hasDiffWithBase) {
+      result.action = 'created'
+      core.info(`Created branch '${branch}'`)
+    } else {
+      core.info(
+        `Branch '${branch}' is not ahead of base '${base}' and will not be created`
+      )
+    }
+  } else {
+    // The pull request branch exists
+    core.info(
+      `Pull request branch '${branch}' already exists as remote branch '${branchRemoteName}/${branch}'`
+    )
+    // Checkout the pull request branch
+    await git.checkout(branch)
+
+    // Reset the branch if one of the following conditions is true.
+    // - If the branch differs from the recreated temp branch.
+    // - If the recreated temp branch is not ahead of the base. This means there will be
+    //   no pull request diff after the branch is reset. This will reset any undeleted
+    //   branches after merging. In particular, it catches a case where the branch was
+    //   squash merged but not deleted. We need to reset to make sure it doesn't appear
+    //   to have a diff with the base due to different commits for the same changes.
+    // - If the number of commits ahead of the base branch differs between the branch and
+    //   temp branch. This catches a case where the base branch has been force pushed to
+    //   a new commit.
+    // For changes on base this reset is equivalent to a rebase of the pull request branch.
+    const tempBranchCommitsAhead = await commitsAhead(git, base, tempBranch)
+    const branchCommitsAhead = await commitsAhead(git, base, branch)
+    if (
+      (await git.hasDiff([`${branch}..${tempBranch}`])) ||
+      branchCommitsAhead != tempBranchCommitsAhead ||
+      !(tempBranchCommitsAhead > 0) // !isAhead
+    ) {
+      core.info(`Resetting '${branch}'`)
+      // Alternatively, git switch -C branch tempBranch
+      await git.checkout(branch, tempBranch)
+    }
+
+    // Check if the pull request branch has been updated
+    // If the branch was reset or updated it will be ahead
+    // It may be behind if a reset now results in no diff with the base
+    if (!(await isEven(git, `${branchRemoteName}/${branch}`, branch))) {
+      result.action = 'updated'
+      core.info(`Updated branch '${branch}'`)
+    } else {
+      result.action = 'not-updated'
+      core.info(
+        `Branch '${branch}' is even with its remote and will not be updated`
+      )
+    }
+
+    // Check if the pull request branch is ahead of the base
+    result.hasDiffWithBase = await isAhead(git, base, branch)
+  }
+
+  // Get the pull request branch SHA
+  result.headSha = await git.revParse('HEAD')
+
+  // Delete the temporary branch
+  await git.exec(['branch', '--delete', '--force', tempBranch])
+
+  return result
+}
+
+interface CreateOrUpdateBranchResult {
+  action: string
+  base: string
+  hasDiffWithBase: boolean
+  headSha: string
+}

src/create-pull-request.py

@@ -1,262 +0,0 @@
-#!/usr/bin/env python3
-''' Create Pull Request '''
-import json
-import os
-import random
-import string
-import sys
-import time
-from git import Repo
-from github import Github
-from github import GithubException
-
-
-def get_github_event(github_event_path):
-    with open(github_event_path) as f:
-        github_event = json.load(f)
-    if bool(os.environ.get('DEBUG_EVENT')):
-        print(os.environ['GITHUB_EVENT_NAME'])
-        print(json.dumps(github_event, sort_keys=True, indent=2))
-    return github_event
-
-
-def get_head_short_sha1(repo):
-    return repo.git.rev_parse('--short', 'HEAD')
-
-
-def get_random_suffix(size=7, chars=string.ascii_lowercase + string.digits):
-    return ''.join(random.choice(chars) for _ in range(size))
-
-
-def remote_branch_exists(repo, branch):
-    for ref in repo.remotes.origin.refs:
-        if ref.name == ("origin/%s" % branch):
-            return True
-    return False
-
-
-def get_author_default(event_name, event_data):
-    if event_name == "push":
-        email = "{head_commit[author][email]}".format(**event_data)
-        name = "{head_commit[author][name]}".format(**event_data)
-    else:
-        email = os.environ['GITHUB_ACTOR'] + '@users.noreply.github.com'
-        name = os.environ['GITHUB_ACTOR']
-    return email, name
-
-
-def set_git_config(git, email, name):
-    git.config('--global', 'user.email', '"%s"' % email)
-    git.config('--global', 'user.name', '"%s"' % name)
-
-
-def set_git_remote_url(git, token, github_repository):
-    git.remote(
-        'set-url', 'origin', "https://x-access-token:%s@github.com/%s" %
-        (token, github_repository))
-
-
-def checkout_branch(git, remote_exists, branch):
-    if remote_exists:
-        git.stash('--include-untracked')
-        git.checkout(branch)
-        try:
-            git.stash('pop')
-        except BaseException:
-            git.checkout('--theirs', '.')
-            git.reset()
-    else:
-        git.checkout('HEAD', b=branch)
-
-
-def push_changes(git, branch, commit_message):
-    git.add('-A')
-    git.commit(m=commit_message)
-    return git.push('-f', '--set-upstream', 'origin', branch)
-
-
-def cs_string_to_list(str):
-    # Split the comma separated string into a list
-    l = [i.strip() for i in str.split(',')]
-    # Remove empty strings
-    return list(filter(None, l))
-
-
-def process_event(github_token, github_repository, repo, branch, base):
-    # Fetch optional environment variables with default values
-    commit_message = os.getenv(
-        'COMMIT_MESSAGE',
-        "Auto-committed changes by create-pull-request action")
-    title = os.getenv(
-        'PULL_REQUEST_TITLE',
-        "Auto-generated by create-pull-request action")
-    body = os.getenv(
-        'PULL_REQUEST_BODY', "Auto-generated pull request by "
-        "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action")
-    # Fetch optional environment variables with no default values
-    pull_request_labels = os.environ.get('PULL_REQUEST_LABELS')
-    pull_request_assignees = os.environ.get('PULL_REQUEST_ASSIGNEES')
-    pull_request_milestone = os.environ.get('PULL_REQUEST_MILESTONE')
-    pull_request_reviewers = os.environ.get('PULL_REQUEST_REVIEWERS')
-    pull_request_team_reviewers = os.environ.get('PULL_REQUEST_TEAM_REVIEWERS')
-
-    # Push the local changes to the remote branch
-    print("Pushing changes.")
-    push_result = push_changes(repo.git, branch, commit_message)
-    print(push_result)
-
-    # Create the pull request
-    github_repo = Github(github_token).get_repo(github_repository)
-    try:
-        pull_request = github_repo.create_pull(
-            title=title,
-            body=body,
-            base=base,
-            head=branch)
-        print("Created pull request #%d (%s => %s)" %
-            (pull_request.number, branch, base))
-    except GithubException as e:
-        if e.status == 422:
-            pull_request = github_repo.get_pulls(
-                state='open', 
-                base=base,
-                head=branch)[0]
-            print("Updated pull request #%d (%s => %s)" %
-                (pull_request.number, branch, base))
-        else:
-            print(str(e))
-            sys.exit(1)
-
-    # Set the output variables
-    os.system(
-        'echo ::set-env name=PULL_REQUEST_NUMBER::%d' %
-        pull_request.number)
-    os.system(
-        'echo ::set-output name=pr_number::%d' %
-        pull_request.number)
-
-    # Set labels, assignees and milestone
-    if pull_request_labels is not None:
-        print("Applying labels")
-        pull_request.as_issue().edit(labels=cs_string_to_list(pull_request_labels))
-    if pull_request_assignees is not None:
-        print("Applying assignees")
-        pull_request.as_issue().edit(assignees=cs_string_to_list(pull_request_assignees))
-    if pull_request_milestone is not None:
-        print("Applying milestone")
-        milestone = github_repo.get_milestone(int(pull_request_milestone))
-        pull_request.as_issue().edit(milestone=milestone)
-
-    # Set pull request reviewers
-    if pull_request_reviewers is not None:
-        print("Requesting reviewers")
-        try:
-            pull_request.create_review_request(
-                reviewers=cs_string_to_list(pull_request_reviewers))
-        except GithubException as e:
-            # Likely caused by "Review cannot be requested from pull request author."
-            if e.status == 422:
-                print("Requesting reviewers failed - %s" % e.data["message"])
-
-    # Set pull request team reviewers
-    if pull_request_team_reviewers is not None:
-        print("Requesting team reviewers")
-        pull_request.create_review_request(
-            team_reviewers=cs_string_to_list(pull_request_team_reviewers))
-
-
-# Fetch environment variables
-github_token = os.environ['GITHUB_TOKEN']
-github_repository = os.environ['GITHUB_REPOSITORY']
-github_ref = os.environ['GITHUB_REF']
-event_name = os.environ['GITHUB_EVENT_NAME']
-# Get the JSON event data
-event_data = get_github_event(os.environ['GITHUB_EVENT_PATH'])
-
-# Set the repo to the working directory
-repo = Repo(os.getcwd())
-# Get the default for author email and name
-author_email, author_name = get_author_default(event_name, event_data)
-# Set commit author overrides
-author_email = os.getenv('COMMIT_AUTHOR_EMAIL', author_email)
-author_name = os.getenv('COMMIT_AUTHOR_NAME', author_name)
-# Set git configuration
-set_git_config(repo.git, author_email, author_name)
-# Update URL for the 'origin' remote
-set_git_remote_url(repo.git, github_token, github_repository)
-
-# Fetch/Set the branch name
-branch_prefix = os.getenv(
-    'PULL_REQUEST_BRANCH',
-    'create-pull-request/patch')
-# Fetch an optional base branch override
-base_override = os.environ.get('PULL_REQUEST_BASE')
-
-# Set the base branch
-if base_override is not None:
-    base = base_override
-    checkout_branch(repo.git, True, base)
-elif github_ref.startswith('refs/pull/'):
-    # Switch to the merging branch instead of the merge commit
-    base = os.environ['GITHUB_HEAD_REF']
-    repo.git.checkout(base)
-else:
-    base = github_ref[11:]
-
-# Skip if the current branch is a PR branch created by this action.
-# This may occur when using a PAT instead of GITHUB_TOKEN.
-if base.startswith(branch_prefix):
-    print("Branch '%s' was created by this action. Skipping." % base)
-    sys.exit()
-
-# Fetch an optional environment variable to determine the branch suffix
-branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
-if branch_suffix == "short-commit-hash":
-    # Suffix with the short SHA1 hash
-    branch = "%s-%s" % (branch_prefix, get_head_short_sha1(repo))
-elif branch_suffix == "timestamp":
-    # Suffix with the current timestamp
-    branch = "%s-%s" % (branch_prefix, int(time.time()))
-elif branch_suffix == "random":
-    # Suffix with the current timestamp
-    branch = "%s-%s" % (branch_prefix, get_random_suffix())
-elif branch_suffix == "none":
-    # Fixed branch name
-    branch = branch_prefix
-else:
-    print(
-        "Branch suffix '%s' is not a valid value." %
-        branch_suffix)
-    sys.exit(1)
-
-# Check if the remote branch exists
-remote_exists = remote_branch_exists(repo, branch)
-
-if remote_exists:
-    if branch_suffix == 'short-commit-hash':
-        # A remote branch already exists for the HEAD commit
-        print(
-            "Pull request branch '%s' already exists for this commit. Skipping." %
-            branch)
-        sys.exit()
-    elif branch_suffix in ['timestamp', 'random']:
-        # Generated branch name clash with an existing branch
-        print(
-            "Pull request branch '%s' already exists. Please re-run." %
-            branch)
-        sys.exit(1)
-
-# Checkout branch
-checkout_branch(repo.git, remote_exists, branch)
-
-# Check if there are changes to pull request
-if repo.is_dirty() or len(repo.untracked_files) > 0:
-    print("Repository has modified or untracked files.")
-    process_event(
-        github_token,
-        github_repository,
-        repo,
-        branch,
-        base)
-else:
-    print("Repository has no modified or untracked files. Skipping.")

src/create-pull-request.ts

@@ -0,0 +1,256 @@
+import * as core from '@actions/core'
+import {
+  createOrUpdateBranch,
+  getWorkingBaseAndType,
+  WorkingBaseType
+} from './create-or-update-branch'
+import {GitHubHelper} from './github-helper'
+import {GitCommandManager} from './git-command-manager'
+import {GitAuthHelper} from './git-auth-helper'
+import * as utils from './utils'
+
+export interface Inputs {
+  token: string
+  path: string
+  addPaths: string[]
+  commitMessage: string
+  committer: string
+  author: string
+  signoff: boolean
+  branch: string
+  deleteBranch: boolean
+  branchSuffix: string
+  base: string
+  pushToFork: string
+  title: string
+  body: string
+  labels: string[]
+  assignees: string[]
+  reviewers: string[]
+  teamReviewers: string[]
+  milestone: number
+  draft: boolean
+}
+
+export async function createPullRequest(inputs: Inputs): Promise<void> {
+  let gitAuthHelper
+  try {
+    // Get the repository path
+    const repoPath = utils.getRepoPath(inputs.path)
+    // Create a git command manager
+    const git = await GitCommandManager.create(repoPath)
+
+    // Save and unset the extraheader auth config if it exists
+    core.startGroup('Save persisted git credentials')
+    gitAuthHelper = new GitAuthHelper(git)
+    await gitAuthHelper.savePersistedAuth()
+    core.endGroup()
+
+    // Init the GitHub client
+    const githubHelper = new GitHubHelper(inputs.token)
+
+    core.startGroup('Determining the base and head repositories')
+    // Determine the base repository from git config
+    const remoteUrl = await git.tryGetRemoteUrl()
+    const baseRemote = utils.getRemoteDetail(remoteUrl)
+    // Determine the head repository; the target for the pull request branch
+    const branchRemoteName = inputs.pushToFork ? 'fork' : 'origin'
+    const branchRepository = inputs.pushToFork
+      ? inputs.pushToFork
+      : baseRemote.repository
+    if (inputs.pushToFork) {
+      // Check if the supplied fork is really a fork of the base
+      core.info(
+        `Checking if '${branchRepository}' is a fork of '${baseRemote.repository}'`
+      )
+      const parentRepository = await githubHelper.getRepositoryParent(
+        branchRepository
+      )
+      if (parentRepository != baseRemote.repository) {
+        throw new Error(
+          `Repository '${branchRepository}' is not a fork of '${baseRemote.repository}'. Unable to continue.`
+        )
+      }
+      // Add a remote for the fork
+      const remoteUrl = utils.getRemoteUrl(
+        baseRemote.protocol,
+        baseRemote.hostname,
+        branchRepository
+      )
+      await git.exec(['remote', 'add', 'fork', remoteUrl])
+    }
+    core.endGroup()
+    core.info(
+      `Pull request branch target repository set to ${branchRepository}`
+    )
+
+    // Configure auth
+    if (baseRemote.protocol == 'HTTPS') {
+      core.startGroup('Configuring credential for HTTPS authentication')
+      await gitAuthHelper.configureToken(inputs.token)
+      core.endGroup()
+    }
+
+    core.startGroup('Checking the base repository state')
+    const [workingBase, workingBaseType] = await getWorkingBaseAndType(git)
+    core.info(`Working base is ${workingBaseType} '${workingBase}'`)
+    // When in detached HEAD state (checked out on a commit), we need to
+    // know the 'base' branch in order to rebase changes.
+    if (workingBaseType == WorkingBaseType.Commit && !inputs.base) {
+      throw new Error(
+        `When the repository is checked out on a commit instead of a branch, the 'base' input must be supplied.`
+      )
+    }
+    // If the base is not specified it is assumed to be the working base.
+    const base = inputs.base ? inputs.base : workingBase
+    // Throw an error if the base and branch are not different branches
+    // of the 'origin' remote. An identically named branch in the `fork`
+    // remote is perfectly fine.
+    if (branchRemoteName == 'origin' && base == inputs.branch) {
+      throw new Error(
+        `The 'base' and 'branch' for a pull request must be different branches. Unable to continue.`
+      )
+    }
+    // For self-hosted runners the repository state persists between runs.
+    // This command prunes the stale remote ref when the pull request branch was
+    // deleted after being merged or closed. Without this the push using
+    // '--force-with-lease' fails due to "stale info."
+    // https://github.com/peter-evans/create-pull-request/issues/633
+    await git.exec(['remote', 'prune', branchRemoteName])
+    core.endGroup()
+
+    // Apply the branch suffix if set
+    if (inputs.branchSuffix) {
+      switch (inputs.branchSuffix) {
+        case 'short-commit-hash':
+          // Suffix with the short SHA1 hash
+          inputs.branch = `${inputs.branch}-${await git.revParse('HEAD', [
+            '--short'
+          ])}`
+          break
+        case 'timestamp':
+          // Suffix with the current timestamp
+          inputs.branch = `${inputs.branch}-${utils.secondsSinceEpoch()}`
+          break
+        case 'random':
+          // Suffix with a 7 character random string
+          inputs.branch = `${inputs.branch}-${utils.randomString()}`
+          break
+        default:
+          throw new Error(
+            `Branch suffix '${inputs.branchSuffix}' is not a valid value. Unable to continue.`
+          )
+      }
+    }
+
+    // Output head branch
+    core.info(
+      `Pull request branch to create or update set to '${inputs.branch}'`
+    )
+
+    // Configure the committer and author
+    core.startGroup('Configuring the committer and author')
+    const parsedAuthor = utils.parseDisplayNameEmail(inputs.author)
+    const parsedCommitter = utils.parseDisplayNameEmail(inputs.committer)
+    git.setIdentityGitOptions([
+      '-c',
+      `author.name=${parsedAuthor.name}`,
+      '-c',
+      `author.email=${parsedAuthor.email}`,
+      '-c',
+      `committer.name=${parsedCommitter.name}`,
+      '-c',
+      `committer.email=${parsedCommitter.email}`
+    ])
+    core.info(
+      `Configured git committer as '${parsedCommitter.name} <${parsedCommitter.email}>'`
+    )
+    core.info(
+      `Configured git author as '${parsedAuthor.name} <${parsedAuthor.email}>'`
+    )
+    core.endGroup()
+
+    // Create or update the pull request branch
+    core.startGroup('Create or update the pull request branch')
+    const result = await createOrUpdateBranch(
+      git,
+      inputs.commitMessage,
+      inputs.base,
+      inputs.branch,
+      branchRemoteName,
+      inputs.signoff,
+      inputs.addPaths
+    )
+    core.endGroup()
+
+    if (['created', 'updated'].includes(result.action)) {
+      // The branch was created or updated
+      core.startGroup(
+        `Pushing pull request branch to '${branchRemoteName}/${inputs.branch}'`
+      )
+      await git.push([
+        '--force-with-lease',
+        branchRemoteName,
+        `HEAD:refs/heads/${inputs.branch}`
+      ])
+      core.endGroup()
+    }
+
+    // Set the base. It would have been '' if not specified as an input
+    inputs.base = result.base
+
+    if (result.hasDiffWithBase) {
+      // Create or update the pull request
+      core.startGroup('Create or update the pull request')
+      const pull = await githubHelper.createOrUpdatePullRequest(
+        inputs,
+        baseRemote.repository,
+        branchRepository
+      )
+      core.endGroup()
+
+      // Set outputs
+      core.startGroup('Setting outputs')
+      core.setOutput('pull-request-number', pull.number)
+      core.setOutput('pull-request-url', pull.html_url)
+      if (pull.created) {
+        core.setOutput('pull-request-operation', 'created')
+      } else if (result.action == 'updated') {
+        core.setOutput('pull-request-operation', 'updated')
+      }
+      core.setOutput('pull-request-head-sha', result.headSha)
+      // Deprecated
+      core.exportVariable('PULL_REQUEST_NUMBER', pull.number)
+      core.endGroup()
+    } else {
+      // There is no longer a diff with the base
+      // Check we are in a state where a branch exists
+      if (['updated', 'not-updated'].includes(result.action)) {
+        core.info(
+          `Branch '${inputs.branch}' no longer differs from base branch '${inputs.base}'`
+        )
+        if (inputs.deleteBranch) {
+          core.info(`Deleting branch '${inputs.branch}'`)
+          await git.push([
+            '--delete',
+            '--force',
+            branchRemoteName,
+            `refs/heads/${inputs.branch}`
+          ])
+          // Set outputs
+          core.startGroup('Setting outputs')
+          core.setOutput('pull-request-operation', 'closed')
+          core.endGroup()
+        }
+      }
+    }
+  } catch (error) {
+    core.setFailed(utils.getErrorMessage(error))
+  } finally {
+    // Remove auth and restore persisted auth config if it existed
+    core.startGroup('Restore persisted git credentials')
+    await gitAuthHelper.removeAuth()
+    await gitAuthHelper.restorePersistedAuth()
+    core.endGroup()
+  }
+}

src/git-auth-helper.ts

@@ -0,0 +1,127 @@
+import * as core from '@actions/core'
+import * as fs from 'fs'
+import {GitCommandManager} from './git-command-manager'
+import * as path from 'path'
+import {URL} from 'url'
+import * as utils from './utils'
+
+export class GitAuthHelper {
+  private git: GitCommandManager
+  private gitConfigPath: string
+  private extraheaderConfigKey: string
+  private extraheaderConfigPlaceholderValue = 'AUTHORIZATION: basic ***'
+  private extraheaderConfigValueRegex = '^AUTHORIZATION:'
+  private persistedExtraheaderConfigValue = ''
+
+  constructor(git: GitCommandManager) {
+    this.git = git
+    this.gitConfigPath = path.join(
+      this.git.getWorkingDirectory(),
+      '.git',
+      'config'
+    )
+    const serverUrl = this.getServerUrl()
+    this.extraheaderConfigKey = `http.${serverUrl.origin}/.extraheader`
+  }
+
+  async savePersistedAuth(): Promise<void> {
+    // Save and unset persisted extraheader credential in git config if it exists
+    this.persistedExtraheaderConfigValue = await this.getAndUnset()
+  }
+
+  async restorePersistedAuth(): Promise<void> {
+    if (this.persistedExtraheaderConfigValue) {
+      try {
+        await this.setExtraheaderConfig(this.persistedExtraheaderConfigValue)
+        core.info('Persisted git credentials restored')
+      } catch (e) {
+        core.warning(utils.getErrorMessage(e))
+      }
+    }
+  }
+
+  async configureToken(token: string): Promise<void> {
+    // Encode and configure the basic credential for HTTPS access
+    const basicCredential = Buffer.from(
+      `x-access-token:${token}`,
+      'utf8'
+    ).toString('base64')
+    core.setSecret(basicCredential)
+    const extraheaderConfigValue = `AUTHORIZATION: basic ${basicCredential}`
+    await this.setExtraheaderConfig(extraheaderConfigValue)
+  }
+
+  async removeAuth(): Promise<void> {
+    await this.getAndUnset()
+  }
+
+  private async setExtraheaderConfig(
+    extraheaderConfigValue: string
+  ): Promise<void> {
+    // Configure a placeholder value. This approach avoids the credential being captured
+    // by process creation audit events, which are commonly logged. For more information,
+    // refer to https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing
+    // See https://github.com/actions/checkout/blob/main/src/git-auth-helper.ts#L267-L274
+    await this.git.config(
+      this.extraheaderConfigKey,
+      this.extraheaderConfigPlaceholderValue
+    )
+    // Replace the placeholder
+    await this.gitConfigStringReplace(
+      this.extraheaderConfigPlaceholderValue,
+      extraheaderConfigValue
+    )
+  }
+
+  private async getAndUnset(): Promise<string> {
+    let configValue = ''
+    // Save and unset persisted extraheader credential in git config if it exists
+    if (
+      await this.git.configExists(
+        this.extraheaderConfigKey,
+        this.extraheaderConfigValueRegex
+      )
+    ) {
+      configValue = await this.git.getConfigValue(
+        this.extraheaderConfigKey,
+        this.extraheaderConfigValueRegex
+      )
+      if (
+        await this.git.tryConfigUnset(
+          this.extraheaderConfigKey,
+          this.extraheaderConfigValueRegex
+        )
+      ) {
+        core.info(`Unset config key '${this.extraheaderConfigKey}'`)
+      } else {
+        core.warning(
+          `Failed to unset config key '${this.extraheaderConfigKey}'`
+        )
+      }
+    }
+    return configValue
+  }
+
+  private async gitConfigStringReplace(
+    find: string,
+    replace: string
+  ): Promise<void> {
+    let content = (await fs.promises.readFile(this.gitConfigPath)).toString()
+    const index = content.indexOf(find)
+    if (index < 0 || index != content.lastIndexOf(find)) {
+      throw new Error(`Unable to replace '${find}' in ${this.gitConfigPath}`)
+    }
+    content = content.replace(find, replace)
+    await fs.promises.writeFile(this.gitConfigPath, content)
+  }
+
+  private getServerUrl(): URL {
+    // todo: remove GITHUB_URL after support for GHES Alpha is no longer needed
+    // See https://github.com/actions/checkout/blob/main/src/url-helper.ts#L22-L29
+    return new URL(
+      process.env['GITHUB_SERVER_URL'] ||
+        process.env['GITHUB_URL'] ||
+        'https://github.com'
+    )
+  }
+}

src/git-command-manager.ts

@@ -0,0 +1,303 @@
+import * as exec from '@actions/exec'
+import * as io from '@actions/io'
+import * as utils from './utils'
+import * as path from 'path'
+
+const tagsRefSpec = '+refs/tags/*:refs/tags/*'
+
+export class GitCommandManager {
+  private gitPath: string
+  private workingDirectory: string
+  // Git options used when commands require an identity
+  private identityGitOptions?: string[]
+
+  private constructor(workingDirectory: string, gitPath: string) {
+    this.workingDirectory = workingDirectory
+    this.gitPath = gitPath
+  }
+
+  static async create(workingDirectory: string): Promise<GitCommandManager> {
+    const gitPath = await io.which('git', true)
+    return new GitCommandManager(workingDirectory, gitPath)
+  }
+
+  setIdentityGitOptions(identityGitOptions: string[]): void {
+    this.identityGitOptions = identityGitOptions
+  }
+
+  async checkout(ref: string, startPoint?: string): Promise<void> {
+    const args = ['checkout', '--progress']
+    if (startPoint) {
+      args.push('-B', ref, startPoint)
+    } else {
+      args.push(ref)
+    }
+    // https://github.com/git/git/commit/a047fafc7866cc4087201e284dc1f53e8f9a32d5
+    args.push('--')
+    await this.exec(args)
+  }
+
+  async cherryPick(
+    options?: string[],
+    allowAllExitCodes = false
+  ): Promise<GitOutput> {
+    const args = ['cherry-pick']
+    if (this.identityGitOptions) {
+      args.unshift(...this.identityGitOptions)
+    }
+
+    if (options) {
+      args.push(...options)
+    }
+
+    return await this.exec(args, allowAllExitCodes)
+  }
+
+  async commit(
+    options?: string[],
+    allowAllExitCodes = false
+  ): Promise<GitOutput> {
+    const args = ['commit']
+    if (this.identityGitOptions) {
+      args.unshift(...this.identityGitOptions)
+    }
+
+    if (options) {
+      args.push(...options)
+    }
+
+    return await this.exec(args, allowAllExitCodes)
+  }
+
+  async config(
+    configKey: string,
+    configValue: string,
+    globalConfig?: boolean
+  ): Promise<void> {
+    await this.exec([
+      'config',
+      globalConfig ? '--global' : '--local',
+      configKey,
+      configValue
+    ])
+  }
+
+  async configExists(
+    configKey: string,
+    configValue = '.',
+    globalConfig?: boolean
+  ): Promise<boolean> {
+    const output = await this.exec(
+      [
+        'config',
+        globalConfig ? '--global' : '--local',
+        '--name-only',
+        '--get-regexp',
+        configKey,
+        configValue
+      ],
+      true
+    )
+    return output.exitCode === 0
+  }
+
+  async fetch(
+    refSpec: string[],
+    remoteName?: string,
+    options?: string[]
+  ): Promise<void> {
+    const args = ['-c', 'protocol.version=2', 'fetch']
+    if (!refSpec.some(x => x === tagsRefSpec)) {
+      args.push('--no-tags')
+    }
+
+    args.push('--progress', '--no-recurse-submodules')
+    if (
+      utils.fileExistsSync(path.join(this.workingDirectory, '.git', 'shallow'))
+    ) {
+      args.push('--unshallow')
+    }
+
+    if (options) {
+      args.push(...options)
+    }
+
+    if (remoteName) {
+      args.push(remoteName)
+    } else {
+      args.push('origin')
+    }
+    for (const arg of refSpec) {
+      args.push(arg)
+    }
+
+    await this.exec(args)
+  }
+
+  async getConfigValue(configKey: string, configValue = '.'): Promise<string> {
+    const output = await this.exec([
+      'config',
+      '--local',
+      '--get-regexp',
+      configKey,
+      configValue
+    ])
+    return output.stdout.trim().split(`${configKey} `)[1]
+  }
+
+  getWorkingDirectory(): string {
+    return this.workingDirectory
+  }
+
+  async hasDiff(options?: string[]): Promise<boolean> {
+    const args = ['diff', '--quiet']
+    if (options) {
+      args.push(...options)
+    }
+    const output = await this.exec(args, true)
+    return output.exitCode === 1
+  }
+
+  async isDirty(untracked: boolean, pathspec?: string[]): Promise<boolean> {
+    const pathspecArgs = pathspec ? ['--', ...pathspec] : []
+    // Check untracked changes
+    const sargs = ['--porcelain', '-unormal']
+    sargs.push(...pathspecArgs)
+    if (untracked && (await this.status(sargs))) {
+      return true
+    }
+    // Check working index changes
+    if (await this.hasDiff(pathspecArgs)) {
+      return true
+    }
+    // Check staged changes
+    const dargs = ['--staged']
+    dargs.push(...pathspecArgs)
+    if (await this.hasDiff(dargs)) {
+      return true
+    }
+    return false
+  }
+
+  async push(options?: string[]): Promise<void> {
+    const args = ['push']
+    if (options) {
+      args.push(...options)
+    }
+    await this.exec(args)
+  }
+
+  async revList(
+    commitExpression: string[],
+    options?: string[]
+  ): Promise<string> {
+    const args = ['rev-list']
+    if (options) {
+      args.push(...options)
+    }
+    args.push(...commitExpression)
+    const output = await this.exec(args)
+    return output.stdout.trim()
+  }
+
+  async revParse(ref: string, options?: string[]): Promise<string> {
+    const args = ['rev-parse']
+    if (options) {
+      args.push(...options)
+    }
+    args.push(ref)
+    const output = await this.exec(args)
+    return output.stdout.trim()
+  }
+
+  async status(options?: string[]): Promise<string> {
+    const args = ['status']
+    if (options) {
+      args.push(...options)
+    }
+    const output = await this.exec(args)
+    return output.stdout.trim()
+  }
+
+  async symbolicRef(ref: string, options?: string[]): Promise<string> {
+    const args = ['symbolic-ref', ref]
+    if (options) {
+      args.push(...options)
+    }
+    const output = await this.exec(args)
+    return output.stdout.trim()
+  }
+
+  async tryConfigUnset(
+    configKey: string,
+    configValue = '.',
+    globalConfig?: boolean
+  ): Promise<boolean> {
+    const output = await this.exec(
+      [
+        'config',
+        globalConfig ? '--global' : '--local',
+        '--unset',
+        configKey,
+        configValue
+      ],
+      true
+    )
+    return output.exitCode === 0
+  }
+
+  async tryGetRemoteUrl(): Promise<string> {
+    const output = await this.exec(
+      ['config', '--local', '--get', 'remote.origin.url'],
+      true
+    )
+
+    if (output.exitCode !== 0) {
+      return ''
+    }
+
+    const stdout = output.stdout.trim()
+    if (stdout.includes('\n')) {
+      return ''
+    }
+
+    return stdout
+  }
+
+  async exec(args: string[], allowAllExitCodes = false): Promise<GitOutput> {
+    const result = new GitOutput()
+
+    const env = {}
+    for (const key of Object.keys(process.env)) {
+      env[key] = process.env[key]
+    }
+
+    const stdout: string[] = []
+    const stderr: string[] = []
+
+    const options = {
+      cwd: this.workingDirectory,
+      env,
+      ignoreReturnCode: allowAllExitCodes,
+      listeners: {
+        stdout: (data: Buffer) => {
+          stdout.push(data.toString())
+        },
+        stderr: (data: Buffer) => {
+          stderr.push(data.toString())
+        }
+      }
+    }
+
+    result.exitCode = await exec.exec(`"${this.gitPath}"`, args, options)
+    result.stdout = stdout.join('')
+    result.stderr = stderr.join('')
+    return result
+  }
+}
+
+class GitOutput {
+  stdout = ''
+  stderr = ''
+  exitCode = 0
+}

src/github-helper.ts

@@ -0,0 +1,183 @@
+import * as core from '@actions/core'
+import {Inputs} from './create-pull-request'
+import {Octokit, OctokitOptions} from './octokit-client'
+import * as utils from './utils'
+
+const ERROR_PR_REVIEW_FROM_AUTHOR =
+  'Review cannot be requested from pull request author'
+
+interface Repository {
+  owner: string
+  repo: string
+}
+
+interface Pull {
+  number: number
+  html_url: string
+  created: boolean
+}
+
+export class GitHubHelper {
+  private octokit: InstanceType<typeof Octokit>
+
+  constructor(token: string) {
+    const options: OctokitOptions = {}
+    if (token) {
+      options.auth = `${token}`
+    }
+    options.baseUrl = process.env['GITHUB_API_URL'] || 'https://api.github.com'
+    this.octokit = new Octokit(options)
+  }
+
+  private parseRepository(repository: string): Repository {
+    const [owner, repo] = repository.split('/')
+    return {
+      owner: owner,
+      repo: repo
+    }
+  }
+
+  private async createOrUpdate(
+    inputs: Inputs,
+    baseRepository: string,
+    headRepository: string
+  ): Promise<Pull> {
+    const [headOwner] = headRepository.split('/')
+    const headBranch = `${headOwner}:${inputs.branch}`
+    const headBranchFull = `${headRepository}:${inputs.branch}`
+
+    // Try to create the pull request
+    try {
+      core.info(`Attempting creation of pull request`)
+      const {data: pull} = await this.octokit.rest.pulls.create({
+        ...this.parseRepository(baseRepository),
+        title: inputs.title,
+        head: headBranch,
+        base: inputs.base,
+        body: inputs.body,
+        draft: inputs.draft
+      })
+      core.info(
+        `Created pull request #${pull.number} (${headBranch} => ${inputs.base})`
+      )
+      return {
+        number: pull.number,
+        html_url: pull.html_url,
+        created: true
+      }
+    } catch (e) {
+      if (
+        utils.getErrorMessage(e).includes(`A pull request already exists for`)
+      ) {
+        core.info(`A pull request already exists for ${headBranch}`)
+      } else {
+        throw e
+      }
+    }
+
+    // Update the pull request that exists for this branch and base
+    core.info(`Fetching existing pull request`)
+    const {data: pulls} = await this.octokit.rest.pulls.list({
+      ...this.parseRepository(baseRepository),
+      state: 'open',
+      head: headBranchFull,
+      base: inputs.base
+    })
+    core.info(`Attempting update of pull request`)
+    const {data: pull} = await this.octokit.rest.pulls.update({
+      ...this.parseRepository(baseRepository),
+      pull_number: pulls[0].number,
+      title: inputs.title,
+      body: inputs.body
+    })
+    core.info(
+      `Updated pull request #${pull.number} (${headBranch} => ${inputs.base})`
+    )
+    return {
+      number: pull.number,
+      html_url: pull.html_url,
+      created: false
+    }
+  }
+
+  async getRepositoryParent(headRepository: string): Promise<string> {
+    const {data: headRepo} = await this.octokit.rest.repos.get({
+      ...this.parseRepository(headRepository)
+    })
+    if (!headRepo.parent) {
+      throw new Error(
+        `Repository '${headRepository}' is not a fork. Unable to continue.`
+      )
+    }
+    return headRepo.parent.full_name
+  }
+
+  async createOrUpdatePullRequest(
+    inputs: Inputs,
+    baseRepository: string,
+    headRepository: string
+  ): Promise<Pull> {
+    // Create or update the pull request
+    const pull = await this.createOrUpdate(
+      inputs,
+      baseRepository,
+      headRepository
+    )
+
+    // Apply milestone
+    if (inputs.milestone) {
+      core.info(`Applying milestone '${inputs.milestone}'`)
+      await this.octokit.rest.issues.update({
+        ...this.parseRepository(baseRepository),
+        issue_number: pull.number,
+        milestone: inputs.milestone
+      })
+    }
+    // Apply labels
+    if (inputs.labels.length > 0) {
+      core.info(`Applying labels '${inputs.labels}'`)
+      await this.octokit.rest.issues.addLabels({
+        ...this.parseRepository(baseRepository),
+        issue_number: pull.number,
+        labels: inputs.labels
+      })
+    }
+    // Apply assignees
+    if (inputs.assignees.length > 0) {
+      core.info(`Applying assignees '${inputs.assignees}'`)
+      await this.octokit.rest.issues.addAssignees({
+        ...this.parseRepository(baseRepository),
+        issue_number: pull.number,
+        assignees: inputs.assignees
+      })
+    }
+
+    // Request reviewers and team reviewers
+    const requestReviewersParams = {}
+    if (inputs.reviewers.length > 0) {
+      requestReviewersParams['reviewers'] = inputs.reviewers
+      core.info(`Requesting reviewers '${inputs.reviewers}'`)
+    }
+    if (inputs.teamReviewers.length > 0) {
+      requestReviewersParams['team_reviewers'] = inputs.teamReviewers
+      core.info(`Requesting team reviewers '${inputs.teamReviewers}'`)
+    }
+    if (Object.keys(requestReviewersParams).length > 0) {
+      try {
+        await this.octokit.rest.pulls.requestReviewers({
+          ...this.parseRepository(baseRepository),
+          pull_number: pull.number,
+          ...requestReviewersParams
+        })
+      } catch (e) {
+        if (utils.getErrorMessage(e).includes(ERROR_PR_REVIEW_FROM_AUTHOR)) {
+          core.warning(ERROR_PR_REVIEW_FROM_AUTHOR)
+        } else {
+          throw e
+        }
+      }
+    }
+
+    return pull
+  }
+}

src/main.ts

@@ -0,0 +1,38 @@
+import * as core from '@actions/core'
+import {Inputs, createPullRequest} from './create-pull-request'
+import {inspect} from 'util'
+import * as utils from './utils'
+
+async function run(): Promise<void> {
+  try {
+    const inputs: Inputs = {
+      token: core.getInput('token'),
+      path: core.getInput('path'),
+      addPaths: utils.getInputAsArray('add-paths'),
+      commitMessage: core.getInput('commit-message'),
+      committer: core.getInput('committer'),
+      author: core.getInput('author'),
+      signoff: core.getBooleanInput('signoff'),
+      branch: core.getInput('branch'),
+      deleteBranch: core.getBooleanInput('delete-branch'),
+      branchSuffix: core.getInput('branch-suffix'),
+      base: core.getInput('base'),
+      pushToFork: core.getInput('push-to-fork'),
+      title: core.getInput('title'),
+      body: core.getInput('body'),
+      labels: utils.getInputAsArray('labels'),
+      assignees: utils.getInputAsArray('assignees'),
+      reviewers: utils.getInputAsArray('reviewers'),
+      teamReviewers: utils.getInputAsArray('team-reviewers'),
+      milestone: Number(core.getInput('milestone')),
+      draft: core.getBooleanInput('draft')
+    }
+    core.debug(`Inputs: ${inspect(inputs)}`)
+
+    await createPullRequest(inputs)
+  } catch (error) {
+    core.setFailed(utils.getErrorMessage(error))
+  }
+}
+
+run()

src/octokit-client.ts

@@ -0,0 +1,28 @@
+import {Octokit as Core} from '@octokit/core'
+import {paginateRest} from '@octokit/plugin-paginate-rest'
+import {restEndpointMethods} from '@octokit/plugin-rest-endpoint-methods'
+import ProxyAgent from 'proxy-agent'
+export {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods'
+export {OctokitOptions} from '@octokit/core/dist-types/types'
+
+export const Octokit = Core.plugin(
+  paginateRest,
+  restEndpointMethods,
+  autoProxyAgent
+)
+
+// Octokit plugin to support the standard environment variables http_proxy, https_proxy and no_proxy
+function autoProxyAgent(octokit: Core) {
+  const proxy =
+    process.env.https_proxy ||
+    process.env.HTTPS_PROXY ||
+    process.env.http_proxy ||
+    process.env.HTTP_PROXY
+
+  if (!proxy) return
+
+  const agent = new ProxyAgent()
+  octokit.hook.before('request', options => {
+    options.request.agent = agent
+  })
+}

src/requirements.txt

@@ -1,2 +0,0 @@
-GitPython==3.0.4
-PyGithub==1.44.1

src/setup-python.js

@@ -1,52 +0,0 @@
-const core = require("@actions/core");
-const tc = require("@actions/tool-cache");
-const path = require("path");
-const semver = require("semver");
-
-/**
- * Setup for Python from the GitHub Actions tool cache
- * Converted from https://github.com/actions/setup-python
- *
- * @param {string} versionSpec version of Python
- * @param {string} arch architecture (x64|x32)
- */
-let setupPython = function(versionSpec, arch) {
-  return new Promise((resolve, reject) => {
-    const IS_WINDOWS = process.platform === "win32";
-
-    // Find the version of Python we want in the tool cache
-    const installDir = tc.find("Python", versionSpec, arch);
-    core.debug(`installDir: ${installDir}`);
-
-    // Set paths
-    core.exportVariable("pythonLocation", installDir);
-    core.addPath(installDir);
-    if (IS_WINDOWS) {
-      core.addPath(path.join(installDir, "Scripts"));
-    } else {
-      core.addPath(path.join(installDir, "bin"));
-    }
-
-    if (IS_WINDOWS) {
-      // Add --user directory
-      // `installDir` from tool cache should look like $AGENT_TOOLSDIRECTORY/Python/<semantic version>/x64/
-      // So if `findLocalTool` succeeded above, we must have a conformant `installDir`
-      const version = path.basename(path.dirname(installDir));
-      const major = semver.major(version);
-      const minor = semver.minor(version);
-
-      const userScriptsDir = path.join(
-        process.env["APPDATA"] || "",
-        "Python",
-        `Python${major}${minor}`,
-        "Scripts"
-      );
-      core.addPath(userScriptsDir);
-    }
-    // On Linux and macOS, pip will create the --user directory and add it to PATH as needed.
-
-    resolve();
-  });
-};
-
-module.exports = setupPython;

src/utils.ts

@@ -0,0 +1,170 @@
+import * as core from '@actions/core'
+import * as fs from 'fs'
+import * as path from 'path'
+
+export function getInputAsArray(
+  name: string,
+  options?: core.InputOptions
+): string[] {
+  return getStringAsArray(core.getInput(name, options))
+}
+
+export function getStringAsArray(str: string): string[] {
+  return str
+    .split(/[\n,]+/)
+    .map(s => s.trim())
+    .filter(x => x !== '')
+}
+
+export function getRepoPath(relativePath?: string): string {
+  let githubWorkspacePath = process.env['GITHUB_WORKSPACE']
+  if (!githubWorkspacePath) {
+    throw new Error('GITHUB_WORKSPACE not defined')
+  }
+  githubWorkspacePath = path.resolve(githubWorkspacePath)
+  core.debug(`githubWorkspacePath: ${githubWorkspacePath}`)
+
+  let repoPath = githubWorkspacePath
+  if (relativePath) repoPath = path.resolve(repoPath, relativePath)
+
+  core.debug(`repoPath: ${repoPath}`)
+  return repoPath
+}
+
+interface RemoteDetail {
+  hostname: string
+  protocol: string
+  repository: string
+}
+
+export function getRemoteDetail(remoteUrl: string): RemoteDetail {
+  // Parse the protocol and github repository from a URL
+  // e.g. HTTPS, peter-evans/create-pull-request
+  const githubUrl = process.env['GITHUB_SERVER_URL'] || 'https://github.com'
+
+  const githubServerMatch = githubUrl.match(/^https?:\/\/(.+)$/i)
+  if (!githubServerMatch) {
+    throw new Error('Could not parse GitHub Server name')
+  }
+
+  const hostname = githubServerMatch[1]
+
+  const httpsUrlPattern = new RegExp(
+    '^https?://.*@?' + hostname + '/(.+/.+?)(\\.git)?$',
+    'i'
+  )
+  const sshUrlPattern = new RegExp('^git@' + hostname + ':(.+/.+)\\.git$', 'i')
+
+  const httpsMatch = remoteUrl.match(httpsUrlPattern)
+  if (httpsMatch) {
+    return {
+      hostname,
+      protocol: 'HTTPS',
+      repository: httpsMatch[1]
+    }
+  }
+
+  const sshMatch = remoteUrl.match(sshUrlPattern)
+  if (sshMatch) {
+    return {
+      hostname,
+      protocol: 'SSH',
+      repository: sshMatch[1]
+    }
+  }
+
+  throw new Error(
+    `The format of '${remoteUrl}' is not a valid GitHub repository URL`
+  )
+}
+
+export function getRemoteUrl(
+  protocol: string,
+  hostname: string,
+  repository: string
+): string {
+  return protocol == 'HTTPS'
+    ? `https://${hostname}/${repository}`
+    : `git@${hostname}:${repository}.git`
+}
+
+export function secondsSinceEpoch(): number {
+  const now = new Date()
+  return Math.round(now.getTime() / 1000)
+}
+
+export function randomString(): string {
+  return Math.random().toString(36).substr(2, 7)
+}
+
+interface DisplayNameEmail {
+  name: string
+  email: string
+}
+
+export function parseDisplayNameEmail(
+  displayNameEmail: string
+): DisplayNameEmail {
+  // Parse the name and email address from a string in the following format
+  // Display Name <email@address.com>
+  const pattern = /^([^<]+)\s*<([^>]+)>$/i
+
+  // Check we have a match
+  const match = displayNameEmail.match(pattern)
+  if (!match) {
+    throw new Error(
+      `The format of '${displayNameEmail}' is not a valid email address with display name`
+    )
+  }
+
+  // Check that name and email are not just whitespace
+  const name = match[1].trim()
+  const email = match[2].trim()
+  if (!name || !email) {
+    throw new Error(
+      `The format of '${displayNameEmail}' is not a valid email address with display name`
+    )
+  }
+
+  return {
+    name: name,
+    email: email
+  }
+}
+
+export function fileExistsSync(path: string): boolean {
+  if (!path) {
+    throw new Error("Arg 'path' must not be empty")
+  }
+
+  let stats: fs.Stats
+  try {
+    stats = fs.statSync(path)
+  } catch (error) {
+    if (hasErrorCode(error) && error.code === 'ENOENT') {
+      return false
+    }
+
+    throw new Error(
+      `Encountered an error when checking whether path '${path}' exists: ${getErrorMessage(
+        error
+      )}`
+    )
+  }
+
+  if (!stats.isDirectory()) {
+    return true
+  }
+
+  return false
+}
+
+/* eslint-disable  @typescript-eslint/no-explicit-any */
+function hasErrorCode(error: any): error is {code: string} {
+  return typeof (error && error.code) === 'string'
+}
+
+export function getErrorMessage(error: unknown) {
+  if (error instanceof Error) return error.message
+  return String(error)
+}

tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "lib": [
+      "es6"
+    ],
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "declaration": true,
+    "strict": true,
+    "noImplicitAny": false,
+    "esModuleInterop": true
+  },
+  "exclude": ["__test__", "lib", "node_modules"]
+}