feat: revert update action runtime to node 16

feat: update action runtime to node 16 (#1074 )
* fix: prefer getMultilineInput and getBooleanInput from actions/core * build: update distribution * feat: update action runtime to node 16 * ci: update setup-node and cache npm dependencies * revert: getMultilineInput to getInputAsArray * build: update distribution
2022-02-28 21:17:05 +09:00 · 2022-02-28 13:55:51 +09:00 · 2022-02-23 15:34:53 +09:00 · 2022-02-23 15:18:03 +09:00 · 2022-01-31 09:49:59 +09:00 · 2022-01-28 11:42:48 +09:00
27 changed files with 19423 additions and 9762 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@ -9,11 +9,15 @@
    "plugin:import/errors",
    "plugin:import/warnings",
    "plugin:import/typescript",
-    "plugin:prettier/recommended",
-    "prettier/@typescript-eslint"
+    "plugin:prettier/recommended"
  ],
  "plugins": ["@typescript-eslint"],
  "rules": {
    "@typescript-eslint/camelcase": "off"
+  },
+  "settings": {
+    "import/resolver": {
+      "typescript": {}
+    }
  }
 }
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -1,12 +1,12 @@
 name: CI
 on:
  push:
-    branches: [master]
+    branches: [main]
    paths-ignore:
      - 'README.md'
      - 'docs/**'
  pull_request:
-    branches: [master]
+    branches: [main]
    paths-ignore:
      - 'README.md'
      - 'docs/**'
@ -45,7 +45,7 @@ jobs:
    steps:
      - uses: actions/checkout@v2
        with:
-          ref: master
+          ref: main
      - if: matrix.target == 'built' || github.event_name == 'pull_request'
        uses: actions/download-artifact@v2
        with:
@ -108,7 +108,7 @@ jobs:
            ```

  package:
-    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    needs: [test]
    runs-on: ubuntu-latest
    steps:
@ -120,10 +120,10 @@ jobs:
      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v3
        with:
-          commit-message: Update distribution
+          commit-message: 'build: update distribution'
          title: Update distribution
          body: |
-            - Updates the distribution for changes on `master`
+            - Updates the distribution for changes on `main`

            Auto-generated by [create-pull-request][1]

--- a/.github/workflows/cpr-example-command.yml
+++ b/.github/workflows/cpr-example-command.yml
@ -34,10 +34,12 @@ jobs:
          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@v1
--- a/.github/workflows/slash-command-dispatch.yml
+++ b/.github/workflows/slash-command-dispatch.yml
@ -18,12 +18,6 @@ jobs:
                "repository": "peter-evans/create-pull-request-tests",
                "named_args": true
              },
-              {
-                "command": "pytest",
-                "permission": "admin",
-                "repository": "peter-evans/create-pull-request-tests",
-                "named_args": true
-              },
              {
                "command": "clean",
                "permission": "admin",
--- a/.github/workflows/update-dep.yml
+++ b/.github/workflows/update-dep.yml
@ -1,31 +0,0 @@
-name: Update Dependencies
-on:
-  schedule:
-    - cron:  '0 1 * * 4'
-jobs:
-  update-dep:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '12.x'
-      - name: Update dependencies
-        run: |
-          npx -p npm-check-updates ncu -u
-          npm install
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
-        with:
-            token: ${{ secrets.ACTIONS_BOT_TOKEN }}
-            commit-message: Update dependencies
-            committer: GitHub <noreply@github.com>
-            author: actions-bot <actions-bot@users.noreply.github.com>
-            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
--- a/.gitignore
+++ b/.gitignore
@ -2,3 +2,4 @@ lib/
 node_modules/

 .DS_Store
+.idea
--- a/README.md
+++ b/README.md
@ -1,6 +1,6 @@
 # <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=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/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=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.

@ -26,6 +26,10 @@ Create Pull Request action will:
 ## Usage

 ```yml
+      - uses: actions/checkout@v2
+
+      # Make changes to pull request here
+
      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v3
 ```
@ -40,13 +44,15 @@ All inputs are **optional**. If not set, sensible defaults will be used.

 | Name | Description | Default |
 | --- | --- | --- |
-| `token` | `GITHUB_TOKEN` or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` |
+| `token` | `GITHUB_TOKEN` (`contents: write`, `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. Defaults to adding all new and modified files. See [Add specific paths](#add-specific-paths). | `-A` |
 | `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. | |
@ -55,14 +61,29 @@ All inputs are **optional**. If not set, sensible defaults will be used.
 | `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). | |
+| `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). | `false` |
+| `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` |
+
+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@v3
+        env:
+          https_proxy: http://<proxy_address>:<port>
+```

 ### Action outputs

-The pull request number is output as a step output.
-Note that in order to read the step output the action step must have an id.
+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
@ -71,17 +92,7 @@ Note that in order to read the step output the action step must have an id.
      - name: Check outputs
        run: |
          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
-```
-
-### Checkout
-
-This action expects repositories to be checked out with `actions/checkout@v2`.
-
-If there is some reason you need to use `actions/checkout@v1` the following step can be added to checkout the branch.
-
-```yml
-      - uses: actions/checkout@v1
-      - run: git checkout "${GITHUB_REF:11}"
+          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
 ```

 ### Action behaviour
@ -95,7 +106,7 @@ How the action behaves:
 - 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 and there are no further changes (i.e. no diff with the current pull request branch) then 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 base and pull request branch), the pull request is automatically closed and the branch deleted.
+- 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.

 For further details about how the action works and usage guidelines, see [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md).

@ -112,9 +123,45 @@ To use this strategy, set input `branch-suffix` with one of the following option

 - `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`

-### Controlling commits
+### Controlling committed files
+
+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.
+
+#### 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.
+
+#### Add specific paths
+
+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.
+Each path must resolve to a least one new or modified file to add.
+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@v3
+        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:
@ -134,10 +181,6 @@ As well as relying on the action to handle uncommitted changes, you can addition
        uses: peter-evans/create-pull-request@v3
 ```

-### Ignoring 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.
-
 ### 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.
@ -155,15 +198,19 @@ To create a project card for the pull request, pass the `pull-request-number` st
          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 is a reference example that sets many of the main inputs.
+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
@ -183,6 +230,7 @@ jobs:
          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
          signoff: false
          branch: example-patches
+          delete-branch: true
          title: '[Example] Update report'
          body: |
            Update report
@ -200,10 +248,6 @@ jobs:
            maintainers
          milestone: 1
          draft: false
-
-      - name: Check output
-        run: |
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
 ```

 An example based on the above reference configuration creates pull requests that look like this:
--- a/test/create-or-update-branch.int.test.ts
+++ b/test/create-or-update-branch.int.test.ts
@ -1,4 +1,8 @@
-import {createOrUpdateBranch, tryFetch} from '../lib/create-or-update-branch'
+import {
+  createOrUpdateBranch,
+  tryFetch,
+  getWorkingBaseAndType
+} from '../lib/create-or-update-branch'
 import * as fs from 'fs'
 import {GitCommandManager} from '../lib/git-command-manager'
 import * as path from 'path'
@ -21,6 +25,9 @@ const BASE = DEFAULT_BRANCH
 const FORK_REMOTE_URL = 'git://127.0.0.1/test-fork.git'
 const FORK_REMOTE_NAME = 'fork'

+const ADD_PATHS = ['-A']
+const ADD_PATHS_WILDCARD = ['*.txt']
+
 async function createFile(filename: string, content?: string): Promise<string> {
  const _content = content ? content : uuidv4()
  const filepath = path.join(REPO_PATH, filename)
@ -193,6 +200,21 @@ describe('create-or-update-branch tests', () => {
    expect(await tryFetch(git, REMOTE_NAME, NOT_EXIST_BRANCH)).toBeFalsy()
  })

+  it('tests getWorkingBaseAndType on a checked out ref', async () => {
+    const [workingBase, workingBaseType] = await getWorkingBaseAndType(git)
+    expect(workingBase).toEqual(BASE)
+    expect(workingBaseType).toEqual('branch')
+  })
+
+  it('tests getWorkingBaseAndType on a checked out commit', async () => {
+    // Checkout the HEAD commit SHA
+    const headSha = await git.revParse('HEAD')
+    await git.exec(['checkout', headSha])
+    const [workingBase, workingBaseType] = await getWorkingBaseAndType(git)
+    expect(workingBase).toEqual(headSha)
+    expect(workingBaseType).toEqual('commit')
+  })
+
  it('tests no changes resulting in no new branch being created', async () => {
    const commitMessage = uuidv4()
    const result = await createOrUpdateBranch(
@ -201,7 +223,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('none')
    expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy()
@ -217,7 +240,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent)
@ -244,7 +268,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -264,7 +289,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent)
@ -291,7 +317,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -313,7 +340,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -341,9 +369,10 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
-    expect(_result.action).toEqual('none')
+    expect(_result.action).toEqual('not-updated')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
    expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
    expect(
@ -361,7 +390,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -397,7 +427,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -427,7 +458,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -454,7 +486,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeFalsy()
@ -474,7 +507,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -513,7 +547,78 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
+    )
+    expect(_result.action).toEqual('updated')
+    expect(_result.hasDiffWithBase).toBeFalsy()
+    expect(await getFileContent(TRACKED_FILE)).toEqual(_changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(_changes.untracked)
+    expect(
+      await gitLogMatches([...commits.commitMsgs, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+  })
+
+  it('tests create, squash merge, and update with identical changes', async () => {
+    // Branches that have been squash merged appear to have a diff with the base due to
+    // different commits for the same changes. To prevent creating pull requests
+    // unnecessarily we reset (rebase) the pull request branch when a reset would result
+    // in no diff with the base. This will reset any undeleted branches after merging.
+
+    // Create tracked and untracked file changes
+    const changes = await createChanges()
+    const commitMessage = uuidv4()
+    const result = await createOrUpdateBranch(
+      git,
+      commitMessage,
+      '',
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
+    )
+    expect(result.action).toEqual('created')
+    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
+    expect(
+      await gitLogMatches([commitMessage, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+
+    // Push pull request branch to remote
+    await git.push([
+      '--force-with-lease',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${BRANCH}`
+    ])
+
+    await afterTest(false)
+    await beforeTest()
+
+    // Create a commit on the base with the same changes as the branch
+    // This simulates squash merge of the pull request
+    const commits = await createCommits(
+      git,
+      1,
+      changes.tracked,
+      changes.untracked
+    )
+    await git.push([
+      '--force',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${DEFAULT_BRANCH}`
+    ])
+
+    // Create the same tracked and untracked file changes (no change on update)
+    const _changes = await createChanges(changes.tracked, changes.untracked)
+    const _commitMessage = uuidv4()
+    const _result = await createOrUpdateBranch(
+      git,
+      _commitMessage,
+      '',
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeFalsy()
@ -534,7 +639,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked)
@ -564,7 +670,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -589,7 +696,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -623,7 +731,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -650,7 +759,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -692,7 +802,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -718,7 +829,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      FORK_REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -746,7 +858,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      FORK_REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -767,7 +880,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      true
+      true,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -802,7 +916,8 @@ describe('create-or-update-branch tests', () => {
      '',
      BRANCH,
      REMOTE_NAME,
-      true
+      true,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -820,6 +935,59 @@ describe('create-or-update-branch tests', () => {
    )
  })

+  it('tests create and update with wildcard add-paths', async () => {
+    // The pull request branch will not be updated
+
+    // Create tracked and untracked file changes
+    const changes = await createChanges()
+    const commitMessage = uuidv4()
+    const result = await createOrUpdateBranch(
+      git,
+      commitMessage,
+      '',
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS_WILDCARD
+    )
+    expect(result.action).toEqual('created')
+    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
+    expect(
+      await gitLogMatches([commitMessage, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+
+    // Push pull request branch to remote
+    await git.push([
+      '--force-with-lease',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${BRANCH}`
+    ])
+
+    await afterTest(false)
+    await beforeTest()
+
+    // Create tracked and untracked file changes
+    const _changes = await createChanges()
+    const _commitMessage = uuidv4()
+    const _result = await createOrUpdateBranch(
+      git,
+      _commitMessage,
+      '',
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS_WILDCARD
+    )
+    expect(_result.action).toEqual('updated')
+    expect(_result.hasDiffWithBase).toBeTruthy()
+    expect(await getFileContent(TRACKED_FILE)).toEqual(_changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(_changes.untracked)
+    expect(
+      await gitLogMatches([_commitMessage, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+  })
+
  // Working Base is Not Base (WBNB)

  it('tests no changes resulting in no new branch being created (WBNB)', async () => {
@ -833,7 +1001,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('none')
    expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy()
@ -852,7 +1021,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent)
@ -882,7 +1052,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -905,7 +1076,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent)
@ -935,7 +1107,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -960,7 +1133,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -991,9 +1165,10 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
-    expect(_result.action).toEqual('none')
+    expect(_result.action).toEqual('not-updated')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
    expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
    expect(
@ -1014,7 +1189,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1053,7 +1229,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -1086,7 +1263,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1116,7 +1294,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeFalsy()
@ -1141,7 +1320,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1183,7 +1363,84 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
+    )
+    expect(_result.action).toEqual('updated')
+    expect(_result.hasDiffWithBase).toBeFalsy()
+    expect(await getFileContent(TRACKED_FILE)).toEqual(_changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(_changes.untracked)
+    expect(
+      await gitLogMatches([...commits.commitMsgs, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+  })
+
+  it('tests create, squash merge, and update with identical changes (WBNB)', async () => {
+    // Branches that have been squash merged appear to have a diff with the base due to
+    // different commits for the same changes. To prevent creating pull requests
+    // unnecessarily we reset (rebase) the pull request branch when a reset would result
+    // in no diff with the base. This will reset any undeleted branches after merging.
+
+    // Set the working base to a branch that is not the pull request base
+    await git.checkout(NOT_BASE_BRANCH)
+
+    // Create tracked and untracked file changes
+    const changes = await createChanges()
+    const commitMessage = uuidv4()
+    const result = await createOrUpdateBranch(
+      git,
+      commitMessage,
+      BASE,
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
+    )
+    expect(result.action).toEqual('created')
+    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
+    expect(
+      await gitLogMatches([commitMessage, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+
+    // Push pull request branch to remote
+    await git.push([
+      '--force-with-lease',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${BRANCH}`
+    ])
+
+    await afterTest(false)
+    await beforeTest()
+
+    // Create a commit on the base with the same changes as the branch
+    // This simulates squash merge of the pull request
+    const commits = await createCommits(
+      git,
+      1,
+      changes.tracked,
+      changes.untracked
+    )
+    await git.push([
+      '--force',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${DEFAULT_BRANCH}`
+    ])
+
+    // Set the working base to a branch that is not the pull request base
+    await git.checkout(NOT_BASE_BRANCH)
+
+    // Create the same tracked and untracked file changes (no change on update)
+    const _changes = await createChanges(changes.tracked, changes.untracked)
+    const _commitMessage = uuidv4()
+    const _result = await createOrUpdateBranch(
+      git,
+      _commitMessage,
+      BASE,
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeFalsy()
@ -1207,7 +1464,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked)
@ -1240,7 +1498,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -1268,7 +1527,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1305,7 +1565,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -1335,7 +1596,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1380,7 +1642,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -1409,7 +1672,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      FORK_REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(result.action).toEqual('created')
    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1440,7 +1704,8 @@ describe('create-or-update-branch tests', () => {
      BASE,
      BRANCH,
      FORK_REMOTE_NAME,
-      false
+      false,
+      ADD_PATHS
    )
    expect(_result.action).toEqual('updated')
    expect(_result.hasDiffWithBase).toBeTruthy()
@ -1450,4 +1715,160 @@ describe('create-or-update-branch tests', () => {
      await gitLogMatches([_commitMessage, INIT_COMMIT_MESSAGE])
    ).toBeTruthy()
  })
+
+  // Working Base is Not a Ref (WBNR)
+  // A commit is checked out leaving the repository in a "detached HEAD" state
+
+  it('tests create and update in detached HEAD state (WBNR)', async () => {
+    // Checkout the HEAD commit SHA
+    const headSha = await git.revParse('HEAD')
+    await git.checkout(headSha)
+
+    // Create tracked and untracked file changes
+    const changes = await createChanges()
+    const commitMessage = uuidv4()
+    const result = await createOrUpdateBranch(
+      git,
+      commitMessage,
+      BASE,
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
+    )
+    expect(result.action).toEqual('created')
+    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
+    expect(
+      await gitLogMatches([commitMessage, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+
+    // Push pull request branch to remote
+    await git.push([
+      '--force-with-lease',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${BRANCH}`
+    ])
+
+    await afterTest(false)
+    await beforeTest()
+
+    // Checkout the HEAD commit SHA
+    const _headSha = await git.revParse('HEAD')
+    await git.checkout(_headSha)
+
+    // Create tracked and untracked file changes
+    const _changes = await createChanges()
+    const _commitMessage = uuidv4()
+    const _result = await createOrUpdateBranch(
+      git,
+      _commitMessage,
+      BASE,
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
+    )
+    expect(_result.action).toEqual('updated')
+    expect(_result.hasDiffWithBase).toBeTruthy()
+    expect(await getFileContent(TRACKED_FILE)).toEqual(_changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(_changes.untracked)
+    expect(
+      await gitLogMatches([_commitMessage, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+  })
+
+  it('tests create and update with commits on the base inbetween, in detached HEAD state (WBNR)', async () => {
+    // Checkout the HEAD commit SHA
+    const headSha = await git.revParse('HEAD')
+    await git.checkout(headSha)
+
+    // Create tracked and untracked file changes
+    const changes = await createChanges()
+    const commitMessage = uuidv4()
+    const result = await createOrUpdateBranch(
+      git,
+      commitMessage,
+      BASE,
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
+    )
+    expect(result.action).toEqual('created')
+    expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
+    expect(
+      await gitLogMatches([commitMessage, INIT_COMMIT_MESSAGE])
+    ).toBeTruthy()
+
+    // Push pull request branch to remote
+    await git.push([
+      '--force-with-lease',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${BRANCH}`
+    ])
+
+    await afterTest(false)
+    await beforeTest()
+
+    // Create commits on the base
+    const commitsOnBase = await createCommits(git)
+    await git.push([
+      '--force',
+      REMOTE_NAME,
+      `HEAD:refs/heads/${DEFAULT_BRANCH}`
+    ])
+
+    // Checkout the HEAD commit SHA
+    const _headSha = await git.revParse('HEAD')
+    await git.checkout(_headSha)
+
+    // Create tracked and untracked file changes
+    const _changes = await createChanges()
+    const _commitMessage = uuidv4()
+    const _result = await createOrUpdateBranch(
+      git,
+      _commitMessage,
+      BASE,
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
+    )
+    expect(_result.action).toEqual('updated')
+    expect(_result.hasDiffWithBase).toBeTruthy()
+    expect(await getFileContent(TRACKED_FILE)).toEqual(_changes.tracked)
+    expect(await getFileContent(UNTRACKED_FILE)).toEqual(_changes.untracked)
+    expect(
+      await gitLogMatches([
+        _commitMessage,
+        ...commitsOnBase.commitMsgs,
+        INIT_COMMIT_MESSAGE
+      ])
+    ).toBeTruthy()
+  })
+
+  // This failure mode is a limitation of the action. Controlling your own commits cannot be used in detached HEAD state.
+  // https://github.com/peter-evans/create-pull-request/issues/902
+  it('tests failure to create with commits on the working base (during the workflow) in detached HEAD state (WBNR)', async () => {
+    // Checkout the HEAD commit SHA
+    const headSha = await git.revParse('HEAD')
+    await git.checkout(headSha)
+
+    // Create commits on the working base
+    const commits = await createCommits(git)
+    const commitMessage = uuidv4()
+    const result = await createOrUpdateBranch(
+      git,
+      commitMessage,
+      BASE,
+      BRANCH,
+      REMOTE_NAME,
+      false,
+      ADD_PATHS
+    )
+    // The action cannot successfully create the branch
+    expect(result.action).toEqual('none')
+  })
 })
--- a/test/integration-tests.sh
+++ b/test/integration-tests.sh
@ -16,7 +16,7 @@ COPY __test__/entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]
 EOF

-    docker build -t $IMAGE .
+    docker build --no-cache -t $IMAGE .
    rm Dockerfile
 fi

--- a/test/utils.unit.test.ts
+++ b/test/utils.unit.test.ts
@ -58,7 +58,7 @@ describe('utils tests', () => {
      utils.getRemoteDetail(remoteUrl)
      // Fail the test if an error wasn't thrown
      expect(true).toEqual(false)
-    } catch (e) {
+    } catch (e: any) {
      expect(e.message).toEqual(
        `The format of '${remoteUrl}' is not a valid GitHub repository URL`
      )
@ -104,7 +104,7 @@ describe('utils tests', () => {
      utils.parseDisplayNameEmail(displayNameEmail1)
      // Fail the test if an error wasn't thrown
      expect(true).toEqual(false)
-    } catch (e) {
+    } catch (e: any) {
      expect(e.message).toEqual(
        `The format of '${displayNameEmail1}' is not a valid email address with display name`
      )
@ -115,7 +115,7 @@ describe('utils tests', () => {
      utils.parseDisplayNameEmail(displayNameEmail2)
      // Fail the test if an error wasn't thrown
      expect(true).toEqual(false)
-    } catch (e) {
+    } catch (e: any) {
      expect(e.message).toEqual(
        `The format of '${displayNameEmail2}' is not a valid email address with display name`
      )
--- a/action.yml
+++ b/action.yml
@ -8,6 +8,13 @@ inputs:
    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.
+    default: |
+      -A
  commit-message:
    description: 'The message to use when committing changes.'
    default: '[create-pull-request] automated change'
@ -27,6 +34,11 @@ inputs:
  branch:
    description: 'The pull request branch name.'
    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 when using the alternative branching strategy.'
  base:
@ -57,11 +69,17 @@ inputs:
  milestone:
    description: 'The number of the milestone to associate the pull request with.'
  draft:
-    description: 'Create a draft pull request'
+    description: 'Create a draft pull request. It is not possible to change draft status after creation except through the web interface'
    default: false
 outputs:
  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'
  main: 'dist/index.js'
--- a/dist/index.js
+++ b/dist/index.js
--- a/docs/assets/cpr-gitgraph.htm
+++ b/docs/assets/cpr-gitgraph.htm
@ -29,37 +29,37 @@
            orientation: "vertical-reverse"
        });

-        const master = gitgraph.branch("master");
-        master.commit("Last commit on base");
-        const localMaster = gitgraph.branch("<#1> master (local)");
-        localMaster.commit({
+        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 made to the local base during the workflow",
+            body: "Changes to the local base during the workflow",
        })
        const remotePatch = gitgraph.branch("create-pull-request/patch");
        remotePatch.merge({
-            branch: localMaster,
+            branch: localMain,
            commitOptions: {
                subject: "[create-pull-request] automated change",
                body: "Changes pushed to create the remote branch",
            },
        });
-        master.commit("New commit on base");
+        main.commit("New commit on base");

-        const localMaster2 = gitgraph.branch("<#2> master (local)");
-        localMaster2.commit({
+        const localMain2 = gitgraph.branch("<#2> main (local)");
+        localMain2.commit({
            subject: "<uncommitted changes>",
-            body: "Changes made to the updated local base during the workflow",
+            body: "Changes to the updated local base during the workflow",
        })
        remotePatch.merge({
-            branch: localMaster2,
+            branch: localMain2,
            commitOptions: {
                subject: "[create-pull-request] automated change",
                body: "Changes force pushed to update the remote branch",
            },
        });

-        master.merge(remotePatch);
+        main.merge(remotePatch);

    </script>

--- a/docs/assets/cpr-gitgraph.png
+++ b/docs/assets/cpr-gitgraph.png
--- a/docs/concepts-guidelines.md
+++ b/docs/concepts-guidelines.md
@ -7,7 +7,7 @@ This document covers terminology, how the action works, general usage guidelines
 - [How the action works](#how-the-action-works)
 - [Guidelines](#guidelines)
  - [Providing a consistent base](#providing-a-consistent-base)
-  - [Pull request events](#pull-request-events)
+  - [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)
@ -16,8 +16,8 @@ This document covers terminology, how the action works, general usage guidelines
  - [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)
-  - [Creating pull requests on tag push](#creating-pull-requests-on-tag-push)

 ## Terminology

@ -30,9 +30,8 @@ A pull request references two branches:

 ## Events and checkout

-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 by the GitHub Actions [checkout](https://github.com/actions/checkout) action.
-
-The majority of events will default to checking out the "last commit on default branch," which in most cases will be the latest commit on `master`.
+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.

@ -44,7 +43,7 @@ The default can be overridden by specifying a `ref` on checkout.

 ## How the action works

-By default, the action expects to be executed on the pull request `base`&mdash;the branch you intend to modify with the proposed changes.
+Unless the `base` input is supplied, the action expects the target repository to be checked out on the pull request `base`&mdash;the branch you intend to modify with the proposed changes.

 Workflow steps:

@ -60,11 +59,11 @@ The following git diagram shows how the action creates and updates a pull reques

 ### 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.
+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 commits from inconsistent branches. Do *not* do this. It will cause multiple pull requests to be created for each additional `base` the action is executed against.
+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:
@ -77,16 +76,29 @@ jobs:
      - uses: actions/checkout@v2
 ```

-Although rare, 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.
+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.

-### Pull request events
+### Events which checkout a commit

-Workflows triggered by `pull_request` events will by default check out a [merge commit](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request). To prevent the merge commit being included in created pull requests it is necessary to checkout the `head_ref`.
+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: actions/checkout@v2
+      - uses: peter-evans/create-pull-request@v3
        with:
-          ref: ${{ github.head_ref }}
+          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@v3
+        with:
+          base: main
 ```

 ### Restrictions on repository forks
@ -118,6 +130,8 @@ jobs:
    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.
@ -131,9 +145,13 @@ Pull requests created by the action using the default `GITHUB_TOKEN` cannot trig
 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.
+
 - 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
@ -146,7 +164,7 @@ Alternatively, use the action directly and reference the commit hash for the ver
  - uses: thirdparty/foo-action@172ec762f2ac8e050062398456fccd30444f8f30
 ```

-This action uses [ncc](https://github.com/zeit/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/master/dist) directory.
+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

@ -230,6 +248,8 @@ GitHub App generated tokens are more secure than using a PAT because GitHub App
    - 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.

@ -257,6 +277,48 @@ GitHub App generated tokens are more secure than using a PAT because GitHub App
          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@v2
+
+      - 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@v3
+        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.
@ -306,63 +368,3 @@ jobs:
      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v3
 ```
-
-### Creating pull requests on tag push
-
-An `on: push` workflow will also trigger when tags are pushed.
-During these events, the `actions/checkout` action will check out the `ref/tags/<tag>` git ref by default.
-This means the repository will *not* be checked out on an active branch.
-
-If you would like to run `create-pull-request` action on the tagged commit you can achieve this by creating a temporary branch as follows.
-
-```yml
-on:
-  push:
-    tags:
-      - 'v*.*.*'
-jobs:
-  example:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Create a temporary tag branch
-        run: |
-          git config --global user.name 'GitHub'
-          git config --global user.email 'noreply@github.com'
-          git checkout -b temp-${GITHUB_REF:10}
-          git push --set-upstream origin temp-${GITHUB_REF:10}
-
-      # Make changes to pull request here
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
-        with:
-          base: master
-
-      - name: Delete tag branch
-        run: |
-          git push --delete origin temp-${GITHUB_REF:10}
-```
-
-This is an alternative, simpler workflow to the one above. However, this is not guaranteed to checkout the tagged commit.
-There is a chance that in between the tag being pushed and checking out the `master` branch in the workflow, another commit is made to `master`. If that possibility is not a concern, this workflow will work fine.
-
-```yml
-on:
-  push:
-    tags:
-      - 'v*.*.*'
-jobs:
-  example:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: master
-
-      # Make changes to pull request here
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
-```
--- a/docs/examples.md
+++ b/docs/examples.md
@ -3,11 +3,14 @@
 - [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)
@ -17,6 +20,8 @@
 - [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)


@ -33,7 +38,7 @@ name: Update AUTHORS
 on:
  push:
    branches:
-      - master
+      - main
 jobs:
  updateAuthors:
    runs-on: ubuntu-latest
@ -57,14 +62,14 @@ jobs:

 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 `master`. Merging the pull request is effectively promoting those changes to production.
+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:
-      - master
+      - main
 jobs:
  productionPromotion:
    runs-on: ubuntu-latest
@ -74,14 +79,53 @@ jobs:
          ref: production
      - name: Reset promotion branch
        run: |
-          git fetch origin master:master
-          git reset --hard master
+          git fetch origin main:main
+          git reset --hard main
      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v3
        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@v2
+        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@v3
+        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.
@ -130,9 +174,9 @@ The above workflow works best in combination with a build workflow triggered on
 name: CI
 on:
  push:
-    branches: [master]
+    branches: [main]
  pull_request:
-    branches: [master]
+    branches: [main]
 jobs:
  build:
    runs-on: ubuntu-latest
@ -276,6 +320,41 @@ jobs:
          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@v2
+        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@v3
+        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.
@ -462,21 +541,6 @@ The recommended method is to use [`set-output`](https://docs.github.com/en/actio
          body: ${{ steps.vars.outputs.pr_body }}
 ```

-Alternatively, [`set-env`](https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable) 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@v3
-        with:
-          title: ${{ env.PULL_REQUEST_TITLE }}
-          body: ${{ env.PULL_REQUEST_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.
@ -497,6 +561,31 @@ The content must be [escaped to preserve newlines](https://github.community/t/se
          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.2
+        with:
+          template: .github/pull-request-template.md
+          vars: |
+            foo: this
+            bar: that
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          body: ${{ steps.template.outputs.result }}
+```
+
 ### Debugging GitHub Actions

 #### Runner Diagnostic Logging
--- a/docs/updating.md
+++ b/docs/updating.md
@ -68,6 +68,6 @@

 ### New features

- Unpushed commits made during the workflow before the action runs will now be considered as changes to be raised in the pull request. See [Controlling commits](https://github.com/peter-evans/create-pull-request#controlling-commits) for details.
+- 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.
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -29,26 +29,29 @@
  },
  "homepage": "https://github.com/peter-evans/create-pull-request",
  "dependencies": {
-    "@actions/core": "1.2.4",
-    "@actions/exec": "1.0.4",
-    "@octokit/core": "3.1.2",
-    "@octokit/plugin-paginate-rest": "2.3.0",
-    "@octokit/plugin-rest-endpoint-methods": "4.1.2",
-    "uuid": "8.3.0"
+    "@actions/core": "^1.6.0",
+    "@actions/exec": "^1.1.0",
+    "@octokit/core": "^3.5.1",
+    "@octokit/plugin-paginate-rest": "^2.17.0",
+    "@octokit/plugin-rest-endpoint-methods": "^5.13.0",
+    "https-proxy-agent": "^5.0.0",
+    "uuid": "^8.3.2"
  },
  "devDependencies": {
-    "@types/jest": "26.0.9",
-    "@types/node": "14.0.27",
-    "@typescript-eslint/parser": "3.9.0",
-    "@zeit/ncc": "0.22.3",
-    "eslint": "7.6.0",
-    "eslint-plugin-github": "4.1.1",
-    "eslint-plugin-jest": "23.20.0",
-    "jest": "26.4.0",
-    "jest-circus": "26.4.0",
-    "js-yaml": "3.14.0",
-    "prettier": "2.0.5",
-    "ts-jest": "26.2.0",
-    "typescript": "3.9.7"
+    "@types/jest": "^27.0.3",
+    "@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": "^25.3.0",
+    "jest": "^27.4.3",
+    "jest-circus": "^27.4.2",
+    "js-yaml": "^4.1.0",
+    "prettier": "^2.5.0",
+    "ts-jest": "^27.0.7",
+    "typescript": "^4.5.2"
  }
 }
--- a/src/create-or-update-branch.ts
+++ b/src/create-or-update-branch.ts
@ -5,6 +5,28 @@ import {v4 as uuidv4} from 'uuid'
 const CHERRYPICK_EMPTY =
  'The previous cherry-pick is now empty, possibly due to conflict resolution.'

+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,
@ -56,15 +78,6 @@ async function isEven(
  )
 }

-async function hasDiff(
-  git: GitCommandManager,
-  branch1: string,
-  branch2: string
-): Promise<boolean> {
-  const result = await git.diff([`${branch1}..${branch2}`])
-  return result.length > 0
-}
-
 function splitLines(multilineString: string): string[] {
  return multilineString
    .split('\n')
@ -78,10 +91,18 @@ export async function createOrUpdateBranch(
  base: string,
  branch: string,
  branchRemoteName: string,
-  signoff: boolean
+  signoff: boolean,
+  addPaths: string[]
 ): Promise<CreateOrUpdateBranchResult> {
-  // Get the working base. This may or may not be the actual base.
-  const workingBase = await git.symbolicRef('HEAD', ['--short'])
+  // 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'
@ -90,7 +111,8 @@ export async function createOrUpdateBranch(
  const result: CreateOrUpdateBranchResult = {
    action: 'none',
    base: base,
-    hasDiffWithBase: false
+    hasDiffWithBase: false,
+    headSha: ''
  }

  // Save the working base changes to a temporary branch
@ -99,22 +121,41 @@ export async function createOrUpdateBranch(
  // Commit any uncommitted changes
  if (await git.isDirty(true)) {
    core.info('Uncommitted changes found. Adding a commit.')
-    await git.exec(['add', '-A'])
+    for (const path of addPaths) {
+      await git.exec(['add', path], true)
+    }
    const params = ['-m', commitMessage]
    if (signoff) {
      params.push('--signoff')
    }
    await git.commit(params)
+    // Remove uncommitted tracked and untracked changes
+    await git.exec(['reset', '--hard'])
+    await git.exec(['clean', '-f'])
  }

  // Perform fetch and reset the working base
  // Commits made during the workflow will be removed
-  await git.fetch([`${workingBase}:${workingBase}`], baseRemote, ['--force'])
+  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 branch '${workingBase}' on to base branch '${base}'`
+      `Rebasing commits made to ${workingBaseType} '${workingBase}' on to base branch '${base}'`
    )
    // Checkout the actual base
    await git.fetch([`${base}:${base}`], baseRemote, ['--force'])
@ -144,7 +185,7 @@ export async function createOrUpdateBranch(
    // 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, 'HEAD')
+    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) {
@ -163,9 +204,18 @@ export async function createOrUpdateBranch(
    // Checkout the pull request branch
    await git.checkout(branch)

-    if (await hasDiff(git, branch, tempBranch)) {
-      // If the branch differs from the recreated temp version then the branch is reset
-      // For changes on base this action is similar to a rebase of the pull request 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.
+    // For changes on base this reset is equivalent to a rebase of the pull request branch.
+    if (
+      (await git.hasDiff([`${branch}..${tempBranch}`])) ||
+      !(await isAhead(git, base, tempBranch))
+    ) {
      core.info(`Resetting '${branch}'`)
      // Alternatively, git switch -C branch tempBranch
      await git.checkout(branch, tempBranch)
@ -178,6 +228,7 @@ export async function createOrUpdateBranch(
      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`
      )
@ -187,6 +238,9 @@ export async function createOrUpdateBranch(
    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])

@ -197,4 +251,5 @@ interface CreateOrUpdateBranchResult {
  action: string
  base: string
  hasDiffWithBase: boolean
+  headSha: string
 }
--- a/src/create-pull-request.ts
+++ b/src/create-pull-request.ts
@ -1,5 +1,9 @@
 import * as core from '@actions/core'
-import {createOrUpdateBranch} from './create-or-update-branch'
+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'
@ -8,11 +12,13 @@ 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
@ -81,24 +87,16 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
      core.endGroup()
    }

-    // Determine if the checked out ref is a valid base for a pull request
-    // The action needs the checked out HEAD ref to be a branch
-    // This check will fail in the following cases:
-    // - HEAD is detached
-    // - HEAD is a merge commit (pull_request events)
-    // - HEAD is a tag
-    core.startGroup('Checking the checked out ref')
-    const symbolicRefResult = await git.exec(
-      ['symbolic-ref', 'HEAD', '--short'],
-      true
-    )
-    if (symbolicRefResult.exitCode != 0) {
-      core.debug(`${symbolicRefResult.stderr}`)
+    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(
-        'The checked out ref is not a valid base for a pull request. Unable to continue.'
+        `When the repository is checked out on a commit instead of a branch, the 'base' input must be supplied.`
      )
    }
-    const workingBase = symbolicRefResult.stdout.trim()
    // 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
@ -109,6 +107,12 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
        `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
@ -170,7 +174,8 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
      inputs.base,
      inputs.branch,
      branchRemoteName,
-      inputs.signoff
+      inputs.signoff,
+      inputs.addPaths
    )
    core.endGroup()

@ -185,32 +190,57 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
        `HEAD:refs/heads/${inputs.branch}`
      ])
      core.endGroup()
+    }

-      // Set the base. It would have been '' if not specified as an input
-      inputs.base = result.base
+    // 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
-        await githubHelper.createOrUpdatePullRequest(
-          inputs,
-          baseRemote.repository,
-          branchRepository
-        )
-      } else {
-        // If there is no longer a diff with the base delete the branch
+    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}'`
        )
-        core.info(`Closing pull request and deleting branch '${inputs.branch}'`)
-        await git.push([
-          '--delete',
-          '--force',
-          branchRemoteName,
-          `refs/heads/${inputs.branch}`
-        ])
+        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) {
+  } catch (error: any) {
    core.setFailed(error.message)
  } finally {
    // Remove auth and restore persisted auth config if it existed
--- a/src/git-auth-helper.ts
+++ b/src/git-auth-helper.ts
@ -33,7 +33,7 @@ export class GitAuthHelper {
      try {
        await this.setExtraheaderConfig(this.persistedExtraheaderConfigValue)
        core.info('Persisted git credentials restored')
-      } catch (e) {
+      } catch (e: any) {
        core.warning(e)
      }
    }
--- a/src/git-command-manager.ts
+++ b/src/git-command-manager.ts
@ -32,6 +32,8 @@ export class GitCommandManager {
    } else {
      args.push(ref)
    }
+    // https://github.com/git/git/commit/a047fafc7866cc4087201e284dc1f53e8f9a32d5
+    args.push('--')
    await this.exec(args)
  }

@ -96,15 +98,6 @@ export class GitCommandManager {
    return output.exitCode === 0
  }

-  async diff(options?: string[]): Promise<string> {
-    const args = ['-c', 'core.pager=cat', 'diff']
-    if (options) {
-      args.push(...options)
-    }
-    const output = await this.exec(args)
-    return output.stdout.trim()
-  }
-
  async fetch(
    refSpec: string[],
    remoteName?: string,
@ -153,18 +146,26 @@ export class GitCommandManager {
    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): Promise<boolean> {
-    const diffArgs = ['--abbrev=40', '--full-index', '--raw']
-    // Check staged changes
-    if (await this.diff([...diffArgs, '--staged'])) {
+    // Check untracked changes
+    if (untracked && (await this.status(['--porcelain', '-unormal']))) {
      return true
    }
    // Check working index changes
-    if (await this.diff(diffArgs)) {
+    if (await this.hasDiff()) {
      return true
    }
-    // Check untracked changes
-    if (untracked && (await this.status(['--porcelain', '-unormal']))) {
+    // Check staged changes
+    if (await this.hasDiff(['--staged'])) {
      return true
    }
    return false
--- a/src/github-helper.ts
+++ b/src/github-helper.ts
@ -10,6 +10,12 @@ interface Repository {
  repo: string
 }

+interface Pull {
+  number: number
+  html_url: string
+  created: boolean
+}
+
 export class GitHubHelper {
  private octokit: InstanceType<typeof Octokit>

@ -18,6 +24,7 @@ export class GitHubHelper {
    if (token) {
      options.auth = `${token}`
    }
+    options.baseUrl = process.env['GITHUB_API_URL'] || 'https://api.github.com'
    this.octokit = new Octokit(options)
  }

@ -33,10 +40,11 @@ export class GitHubHelper {
    inputs: Inputs,
    baseRepository: string,
    headBranch: string
-  ): Promise<number> {
+  ): Promise<Pull> {
    // Try to create the pull request
    try {
-      const {data: pull} = await this.octokit.pulls.create({
+      core.info(`Attempting creation of pull request`)
+      const {data: pull} = await this.octokit.rest.pulls.create({
        ...this.parseRepository(baseRepository),
        title: inputs.title,
        head: headBranch,
@ -47,38 +55,49 @@ export class GitHubHelper {
      core.info(
        `Created pull request #${pull.number} (${headBranch} => ${inputs.base})`
      )
-      return pull.number
-    } catch (e) {
+      return {
+        number: pull.number,
+        html_url: pull.html_url,
+        created: true
+      }
+    } catch (e: any) {
      if (
-        !e.message ||
-        !e.message.includes(`A pull request already exists for ${headBranch}`)
+        e.message &&
+        e.message.includes(`A pull request already exists for ${headBranch}`)
      ) {
+        core.info(`A pull request already exists for ${headBranch}`)
+      } else {
        throw e
      }
    }

    // Update the pull request that exists for this branch and base
-    const {data: pulls} = await this.octokit.pulls.list({
+    core.info(`Fetching existing pull request`)
+    const {data: pulls} = await this.octokit.rest.pulls.list({
      ...this.parseRepository(baseRepository),
      state: 'open',
      head: headBranch,
      base: inputs.base
    })
-    const {data: pull} = await this.octokit.pulls.update({
+    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,
-      draft: inputs.draft
+      body: inputs.body
    })
    core.info(
      `Updated pull request #${pull.number} (${headBranch} => ${inputs.base})`
    )
-    return pull.number
+    return {
+      number: pull.number,
+      html_url: pull.html_url,
+      created: false
+    }
  }

  async getRepositoryParent(headRepository: string): Promise<string> {
-    const {data: headRepo} = await this.octokit.repos.get({
+    const {data: headRepo} = await this.octokit.rest.repos.get({
      ...this.parseRepository(headRepository)
    })
    if (!headRepo.parent) {
@ -93,42 +112,38 @@ export class GitHubHelper {
    inputs: Inputs,
    baseRepository: string,
    headRepository: string
-  ): Promise<void> {
+  ): Promise<Pull> {
    const [headOwner] = headRepository.split('/')
    const headBranch = `${headOwner}:${inputs.branch}`

    // Create or update the pull request
-    const pullNumber = await this.createOrUpdate(
-      inputs,
-      baseRepository,
-      headBranch
-    )
+    const pull = await this.createOrUpdate(inputs, baseRepository, headBranch)

-    // Set outputs
-    core.startGroup('Setting outputs')
-    core.setOutput('pull-request-number', pullNumber)
-    core.exportVariable('PULL_REQUEST_NUMBER', pullNumber)
-    core.endGroup()
-
-    // Set milestone, labels and assignees
-    const updateIssueParams = {}
+    // Apply milestone
    if (inputs.milestone) {
-      updateIssueParams['milestone'] = inputs.milestone
      core.info(`Applying milestone '${inputs.milestone}'`)
-    }
-    if (inputs.labels.length > 0) {
-      updateIssueParams['labels'] = inputs.labels
-      core.info(`Applying labels '${inputs.labels}'`)
-    }
-    if (inputs.assignees.length > 0) {
-      updateIssueParams['assignees'] = inputs.assignees
-      core.info(`Applying assignees '${inputs.assignees}'`)
-    }
-    if (Object.keys(updateIssueParams).length > 0) {
-      await this.octokit.issues.update({
+      await this.octokit.rest.issues.update({
        ...this.parseRepository(baseRepository),
-        issue_number: pullNumber,
-        ...updateIssueParams
+        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
      })
    }

@ -144,12 +159,12 @@ export class GitHubHelper {
    }
    if (Object.keys(requestReviewersParams).length > 0) {
      try {
-        await this.octokit.pulls.requestReviewers({
+        await this.octokit.rest.pulls.requestReviewers({
          ...this.parseRepository(baseRepository),
-          pull_number: pullNumber,
+          pull_number: pull.number,
          ...requestReviewersParams
        })
-      } catch (e) {
+      } catch (e: any) {
        if (e.message && e.message.includes(ERROR_PR_REVIEW_FROM_AUTHOR)) {
          core.warning(ERROR_PR_REVIEW_FROM_AUTHOR)
        } else {
@ -157,5 +172,7 @@ export class GitHubHelper {
        }
      }
    }
+
+    return pull
  }
 }
--- a/src/main.ts
+++ b/src/main.ts
@ -8,11 +8,13 @@ async function run(): Promise<void> {
    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.getInput('signoff') === 'true',
      branch: core.getInput('branch'),
+      deleteBranch: core.getInput('delete-branch') === 'true',
      branchSuffix: core.getInput('branch-suffix'),
      base: core.getInput('base'),
      pushToFork: core.getInput('push-to-fork'),
@ -28,7 +30,7 @@ async function run(): Promise<void> {
    core.debug(`Inputs: ${inspect(inputs)}`)

    await createPullRequest(inputs)
-  } catch (error) {
+  } catch (error: any) {
    core.setFailed(error.message)
  }
 }
--- a/src/octokit-client.ts
+++ b/src/octokit-client.ts
@ -1,7 +1,23 @@
 import {Octokit as Core} from '@octokit/core'
 import {paginateRest} from '@octokit/plugin-paginate-rest'
 import {restEndpointMethods} from '@octokit/plugin-rest-endpoint-methods'
+import {HttpsProxyAgent} from 'https-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)
+export const Octokit = Core.plugin(
+  paginateRest,
+  restEndpointMethods,
+  autoProxyAgent
+)
+
+// Octokit plugin to support the https_proxy environment variable
+function autoProxyAgent(octokit: Core) {
+  const proxy = process.env.https_proxy || process.env.HTTPS_PROXY
+  if (!proxy) return
+
+  const agent = new HttpsProxyAgent(proxy)
+  octokit.hook.before('request', options => {
+    options.request.agent = agent
+  })
+}
--- a/src/utils.ts
+++ b/src/utils.ts
@ -39,8 +39,21 @@ interface RemoteDetail {
 export function getRemoteDetail(remoteUrl: string): RemoteDetail {
  // Parse the protocol and github repository from a URL
  // e.g. HTTPS, peter-evans/create-pull-request
-  const httpsUrlPattern = /^https:\/\/.*@?github.com\/(.+\/.+)$/i
-  const sshUrlPattern = /^git@github.com:(.+\/.+).git$/i
+  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 httpsUrlPattern = new RegExp(
+    '^https?://.*@?' + githubServerMatch[1] + '/(.+/.+)$',
+    'i'
+  )
+  const sshUrlPattern = new RegExp(
+    '^git@' + githubServerMatch[1] + ':(.+/.+).git$',
+    'i'
+  )

  const httpsMatch = remoteUrl.match(httpsUrlPattern)
  if (httpsMatch) {
@ -121,7 +134,7 @@ export function fileExistsSync(path: string): boolean {
  let stats: fs.Stats
  try {
    stats = fs.statSync(path)
-  } catch (error) {
+  } catch (error: any) {
    if (error.code === 'ENOENT') {
      return false
    }
Author	SHA1	Message	Date
Peter Evans	18f7dc018c	feat: revert update action runtime to node 16	2022-02-28 21:17:05 +09:00
Sibiraj	89265e8d24	feat: update action runtime to node 16 (#1074 ) * fix: prefer getMultilineInput and getBooleanInput from actions/core * build: update distribution * feat: update action runtime to node 16 * ci: update setup-node and cache npm dependencies * revert: getMultilineInput to getInputAsArray * build: update distribution	2022-02-28 13:55:51 +09:00
Peter Evans	a7bb76508d	fix: remove unused draft param from pull update (#1065 )	2022-02-23 15:34:53 +09:00
Will Thames	357cebe268	Document that draft status changes are not reflected (#1064 ) The github pull request update API does not accept changing draft status - the only way to do it appears to be through the web UI.	2022-02-23 15:18:03 +09:00
Kenji Miyake	f22a7da129	fix: add '--' to checkout command to avoid ambiguity (#1051 ) * fix: add '--' to checkout command to avoid ambiguity Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * Update src/git-command-manager.ts Co-authored-by: Peter Evans <18365890+peter-evans@users.noreply.github.com> Co-authored-by: Peter Evans <18365890+peter-evans@users.noreply.github.com>	2022-01-31 09:49:59 +09:00
Peter Evans	3f60247108	ci: remove workflow (#1046 )	2022-01-28 11:42:48 +09:00
Peter Evans	dcd5fd746d	feat: add-paths input (#1010 ) * add add-pattern-array argument * ignore return code * doc to add-pattern-array * update README.md * cleanup after success commit * fix integration tests * add test * update naming and docs * update readme * fix missing await * update docs Co-authored-by: avdim <avdim@mail.ru> Co-authored-by: Авдеев Дима <avdeev@tutu.tech>	2021-12-14 11:23:29 +09:00
Peter Evans	4b53b6fd1a	Merge pull request #967 from peter-evans/update-dependencies Update dependencies	2021-12-02 12:02:05 +09:00
Peter Evans	10a1849302	chore: update dist	2021-12-02 11:19:12 +09:00
Peter Evans	c209d72428	chore: update package lock	2021-12-02 11:18:20 +09:00
Peter Evans	ef9e028216	fix: resolving path to module	2021-12-02 11:17:26 +09:00
actions-bot	f8f85df783	chore: update dependencies	2021-12-02 01:25:39 +00:00
Peter Evans	b9117f2e0c	Merge pull request #992 from MichaelCurrin/patch-1 docs: update marketplace logo	2021-12-02 08:56:24 +09:00
Michael Currin	598ffcd35c	docs: update marketplace logo	2021-12-01 12:59:42 +02:00
Peter Evans	d8e8e547cc	Merge pull request #986 from irphilli/docs/github-app-permissions docs: Update to include app permissions needed to add teams as reviewers	2021-11-15 09:14:49 +09:00
Phil Phillips	507420e035	docs: Update to include app permissions needed to add teams as reviewers	2021-11-12 12:26:36 -06:00
Peter Evans	67df31e08a	fix: add head sha output to action.yml	2021-11-04 11:13:50 +09:00
Peter Evans	f530141cd3	Merge pull request #981 from peter-evans/update-distribution Update distribution	2021-11-04 11:07:54 +09:00
peter-evans	a5a72ba246	build: update distribution	2021-11-04 02:07:25 +00:00
Peter Evans	a6c8b3814a	Merge pull request #976 from peter-evans/output-sha feat: add output for head sha	2021-11-04 11:04:47 +09:00
Peter Evans	c0a9598b0e	feat: add output for head sha	2021-11-04 10:42:17 +09:00
Peter Evans	3c3d696d5b	Merge pull request #955 from peter-evans/dependabot/npm_and_yarn/ansi-regex-5.0.1 build(deps): bump ansi-regex from 5.0.0 to 5.0.1	2021-10-07 11:09:44 +09:00
Peter Evans	bd0f84d69c	Merge pull request #958 from peter-evans/update-distribution Update distribution	2021-10-07 10:50:19 +09:00
peter-evans	ad71e1f128	build: update distribution	2021-10-07 01:48:29 +00:00
dependabot[bot]	368c9da6f6	build(deps): bump ansi-regex from 5.0.0 to 5.0.1 Bumps [ansi-regex](https://github.com/chalk/ansi-regex) from 5.0.0 to 5.0.1. - [Release notes](https://github.com/chalk/ansi-regex/releases) - [Commits](https://github.com/chalk/ansi-regex/compare/v5.0.0...v5.0.1) --- updated-dependencies: - dependency-name: ansi-regex dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2021-10-07 01:46:56 +00:00
Peter Evans	d8a389d1fa	Merge pull request #932 from peter-evans/update-dependencies Update dependencies	2021-10-07 10:46:28 +09:00
actions-bot	225cf628aa	chore: update dependencies	2021-10-07 01:25:48 +00:00
Peter Evans	d7a8d0affc	ci: revert test of new scd version This reverts commit `2dc79e58de`.	2021-09-17 09:59:51 +09:00
Peter Evans	2dc79e58de	ci: test new scd version	2021-09-16 14:56:26 +09:00
Peter Evans	95767e7d51	Merge pull request #894 from peter-evans/update-dependencies Update dependencies	2021-09-02 14:10:28 +09:00
Peter Evans	3263596ac4	fix: set error types to any	2021-09-02 13:59:32 +09:00
Peter Evans	3e21ec0c82	chore: update package-lock	2021-09-02 13:54:47 +09:00
actions-bot	5050a372c9	chore: update dependencies	2021-09-02 01:24:01 +00:00
Peter Evans	7380612b49	Merge pull request #915 from peter-evans/missing-outputs fix: add missing outputs	2021-08-23 12:59:53 +09:00
Peter Evans	771ad1b5f4	fix: add missing outputs	2021-08-23 12:51:26 +09:00
Peter Evans	093c191148	Merge pull request #903 from peter-evans/failure-mode-test test: add test for detached head failure mode	2021-08-13 11:47:40 +09:00
Peter Evans	00cb0abb4d	build: update package lock version	2021-08-13 11:35:07 +09:00
Peter Evans	fa0950476f	test: add test for detached head failure mode	2021-08-13 11:34:19 +09:00
Peter Evans	b90b9c1e20	Merge pull request #890 from peter-evans/update-distribution Update distribution	2021-07-22 11:05:37 +09:00
peter-evans	028a63020c	build: update distribution	2021-07-22 02:05:00 +00:00
Peter Evans	9d59234a82	Merge pull request #864 from peter-evans/update-dependencies Update dependencies	2021-07-22 11:02:56 +09:00
actions-bot	210f7aab2c	chore: update dependencies	2021-07-22 01:26:10 +00:00
Peter Evans	6bb7394339	Merge pull request #850 from peter-evans/update-distribution Update distribution	2021-05-27 13:22:56 +09:00
peter-evans	a518698c07	build: update distribution	2021-05-27 04:20:57 +00:00
Peter Evans	8be395fdd3	Merge pull request #834 from peter-evans/update-dependencies Update dependencies	2021-05-27 13:18:59 +09:00
actions-bot	36d063872e	chore: update dependencies	2021-05-27 01:32:21 +00:00
Peter Evans	9825ae65b1	Merge pull request #837 from peter-evans/proxy-support feat: add support for https_proxy env var	2021-05-24 15:11:36 +09:00
Peter Evans	243251cf92	docs: update readme	2021-05-24 15:06:55 +09:00
Peter Evans	28beef91aa	feat: add support for https_proxy env var	2021-05-22 09:32:10 +09:00
Peter Evans	01f7dd1d28	Merge pull request #829 from peter-evans/logging fix: improve logging	2021-05-14 13:58:45 +09:00
Peter Evans	32c71c837c	fix: improve logging	2021-05-14 13:47:55 +09:00
Peter Evans	a6d621d73e	Merge pull request #820 from peter-evans/dependabot/npm_and_yarn/hosted-git-info-2.8.9 build(deps): bump hosted-git-info from 2.8.8 to 2.8.9	2021-05-13 13:18:59 +09:00
Peter Evans	09f51e6391	Merge pull request #819 from peter-evans/dependabot/npm_and_yarn/lodash-4.17.21 build(deps): bump lodash from 4.17.19 to 4.17.21	2021-05-13 13:09:37 +09:00
dependabot[bot]	ed04db61de	build(deps): bump hosted-git-info from 2.8.8 to 2.8.9 Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.8.8 to 2.8.9. - [Release notes](https://github.com/npm/hosted-git-info/releases) - [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md) - [Commits](https://github.com/npm/hosted-git-info/compare/v2.8.8...v2.8.9) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-13 03:57:30 +00:00
dependabot[bot]	ea6b55fc9d	build(deps): bump lodash from 4.17.19 to 4.17.21 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.19 to 4.17.21. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](https://github.com/lodash/lodash/compare/4.17.19...4.17.21) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-13 03:57:16 +00:00
Peter Evans	88896f707d	Merge pull request #816 from peter-evans/update-distribution Update distribution	2021-05-13 12:51:15 +09:00
peter-evans	423630f7c0	build: update distribution	2021-05-13 03:50:34 +00:00
Peter Evans	66cc0cc1e2	Merge pull request #776 from peter-evans/update-dependencies Update dependencies	2021-05-13 12:48:13 +09:00
actions-bot	2a63057d1e	chore: update dependencies	2021-05-13 02:16:24 +00:00
Peter Evans	f83efdc34a	docs: update default branch	2021-05-13 09:53:24 +09:00
Peter Evans	fff683e9ca	docs: update default branch	2021-05-13 09:43:00 +09:00
Peter Evans	9f83247b25	ci: update default branch	2021-05-13 09:42:47 +09:00
Peter Evans	670e508eb6	docs: update readme	2021-05-11 10:12:39 +09:00
Peter Evans	d9d6fd980e	Merge pull request #804 from peter-evans/gpg-sign-fix fix: remove unnecessary gpg-sign input	2021-05-10 09:19:01 +09:00
Peter Evans	8bb8511e4d	fix: remove unnecessary gpg-sign input	2021-05-10 09:01:53 +09:00
Peter Evans	c1d92ef456	docs: update readme	2021-05-09 14:44:37 +09:00
Peter Evans	1ff93da091	Merge pull request #795 from peter-evans/gpg-sign feat: add input to enable gpg commit signing	2021-05-09 14:15:03 +09:00
Peter Evans	0524c01297	feat: add input to enable gpg commit signing	2021-05-09 10:14:59 +09:00
Peter Evans	548adff9dc	docs: update examples	2021-04-09 15:03:53 +09:00
Peter Evans	28674474a4	docs: add link to github blog post	2021-04-06 10:46:44 +09:00
Peter Evans	4fb90330a4	Merge pull request #773 from peter-evans/update-distribution Update distribution	2021-04-01 12:08:39 +09:00
peter-evans	e4c811acf5	build: update distribution	2021-04-01 03:07:25 +00:00
Peter Evans	99ccb3479b	Merge pull request #759 from peter-evans/update-dependencies Update dependencies	2021-04-01 12:05:05 +09:00
Peter Evans	13616a4432	fix: update octokit rest methods	2021-04-01 11:56:16 +09:00
actions-bot	b5b91bc2b0	chore: update dependencies	2021-04-01 01:28:21 +00:00
Peter Evans	5666cd8fe9	Merge pull request #755 from peter-evans/update-distribution Update distribution	2021-03-16 11:35:49 +09:00
peter-evans	ad897490d5	build: update distribution	2021-03-16 02:35:04 +00:00
Peter Evans	0735106af9	Merge pull request #744 from peter-evans/update-dependencies Update dependencies	2021-03-16 11:31:26 +09:00
Peter Evans	9aeedaa8c2	fix: remove unnecessary prettier config	2021-03-16 11:16:45 +09:00
actions-bot	52d31873b6	chore: update dependencies	2021-03-11 01:43:57 +00:00
Peter Evans	09b9ac155b	Merge pull request #740 from peter-evans/update-distribution Update distribution	2021-02-25 11:22:27 +09:00
peter-evans	6ec5e3e26b	build: update distribution	2021-02-25 02:20:17 +00:00
Peter Evans	8b46437b6d	Merge pull request #709 from peter-evans/update-dependencies Update dependencies	2021-02-25 11:17:55 +09:00
actions-bot	e361fd1788	chore: update dependencies	2021-02-25 01:38:41 +00:00
Peter Evans	052fc72b41	Merge pull request #724 from peter-evans/fix-assignees fix: use the correct assignees property	2021-02-10 09:28:28 +09:00
Peter Evans	ed00d4629c	fix: use the correct assignees property	2021-02-10 09:00:23 +09:00
Peter Evans	34371f09e5	Merge pull request #719 from peter-evans/add-to-lists fix: add to labels and assignees instead of resetting	2021-02-08 10:19:41 +09:00
Peter Evans	c27ea51ae0	fix: add to labels and assignees instead of resetting	2021-02-08 09:32:46 +09:00
Peter Evans	5e9d0ee9ea	Merge pull request #712 from peter-evans/operation-output feat: add pull-request-operation output	2021-02-01 10:28:29 +09:00
Peter Evans	b5f41d9b08	feat: add pull-request-operation output	2021-02-01 09:57:11 +09:00
Peter Evans	2455e15969	Merge pull request #704 from jonico/support-ghes Support GitHub Enterprise Server	2021-01-26 11:17:38 +09:00
Johannes Nicolai	05bc46786e	Support GitHub Server API URL * pass GitHub Server API in Octokkit constructor	2021-01-25 19:16:19 +01:00
Johannes Nicolai	adc6552966	Support GitHub Enterprise Server * parse GITHUB_SERVER_URL if present * accept proper server remotes as well	2021-01-25 18:25:20 +01:00
Peter Evans	171fc6cce4	Merge pull request #701 from peter-evans/update-distribution Update distribution	2021-01-25 14:22:27 +09:00
peter-evans	3fb765f674	build: update distribution	2021-01-25 05:19:37 +00:00
Peter Evans	d95c81ee98	Merge pull request #686 from peter-evans/update-dependencies Update dependencies	2021-01-25 14:16:59 +09:00
actions-bot	8d5ed6557f	chore: update dependencies	2021-01-21 02:46:33 +00:00
Peter Evans	7b1819c092	Merge pull request #683 from peter-evans/update-distribution Update distribution	2020-12-28 10:22:06 +09:00
peter-evans	be0a8c9666	build: update distribution	2020-12-28 01:20:44 +00:00
Peter Evans	a0a6157bf1	Merge pull request #594 from peter-evans/update-dependencies Update dependencies	2020-12-28 10:18:18 +09:00
actions-bot	9c5ec2e07d	chore: update dependencies	2020-12-24 02:04:52 +00:00
Peter Evans	45c510e1f6	Merge pull request #672 from peter-evans/reset-perf perf: git reset instead of fetch	2020-12-23 14:28:23 +09:00
Peter Evans	249b80db6b	perf: git reset instead of fetch	2020-12-23 14:10:40 +09:00
Peter Evans	6c2b44c6ac	Merge pull request #666 from peter-evans/dependabot/npm_and_yarn/node-notifier-8.0.1 build(deps): bump node-notifier from 8.0.0 to 8.0.1	2020-12-23 09:48:12 +09:00
dependabot[bot]	76c58cf6a9	build(deps): bump node-notifier from 8.0.0 to 8.0.1 Bumps [node-notifier](https://github.com/mikaelbr/node-notifier) from 8.0.0 to 8.0.1. - [Release notes](https://github.com/mikaelbr/node-notifier/releases) - [Changelog](https://github.com/mikaelbr/node-notifier/blob/v8.0.1/CHANGELOG.md) - [Commits](https://github.com/mikaelbr/node-notifier/compare/v8.0.0...v8.0.1) Signed-off-by: dependabot[bot] <support@github.com>	2020-12-22 13:17:50 +00:00
Peter Evans	8c603dbb04	Merge pull request #653 from peter-evans/fix-error-handling fix: change or->and to catch all errors	2020-12-09 09:56:23 +09:00
Peter Evans	d01e0807ef	fix: change or->and to catch all errors	2020-12-09 09:38:10 +09:00
Peter Evans	ce699aa2d1	Merge pull request #637 from peter-evans/prune-remote fix: prune stale remote ref for self-hosted runners	2020-11-25 12:40:23 +09:00
Peter Evans	9984f611a7	fix: prune stale remote ref for self-hosted runners	2020-11-24 12:34:57 +09:00
Peter Evans	ff0beed1b2	Merge pull request #627 from peter-evans/git-diff-perf perf: set diff quiet and switch isdirty command order	2020-11-17 13:22:44 +09:00
Peter Evans	ddeca94037	perf: set diff quiet and switch isdirty command order	2020-11-17 11:42:31 +09:00
Peter Evans	0fd77ba8cc	docs: add missing contents link	2020-10-26 09:23:01 +09:00
Peter Evans	c7f493a800	docs: remove deprecated set-env example	2020-10-02 15:53:49 +09:00
Peter Evans	91664dfb28	Merge pull request #604 from peter-evans/update-distribution Update distribution	2020-10-02 15:18:04 +09:00
peter-evans	13ec5274b1	build: update distribution	2020-10-02 06:17:23 +00:00
Peter Evans	bcf9790963	Merge pull request #599 from peter-evans/dependabot/npm_and_yarn/actions/core-1.2.6 Bump @actions/core from 1.2.5 to 1.2.6	2020-10-02 15:14:43 +09:00
dependabot[bot]	88ea447de7	Bump @actions/core from 1.2.5 to 1.2.6 Bumps [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core) from 1.2.5 to 1.2.6. - [Release notes](https://github.com/actions/toolkit/releases) - [Changelog](https://github.com/actions/toolkit/blob/main/packages/core/RELEASES.md) - [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/core) Signed-off-by: dependabot[bot] <support@github.com>	2020-10-01 17:24:16 +00:00
Peter Evans	da928d5fcc	Merge pull request #587 from peter-evans/url-output feat: output the pull request url	2020-09-17 11:18:34 +09:00
Peter Evans	2465e435b9	feat: output the pull request url	2020-09-17 10:41:26 +09:00
Peter Evans	37b2bd1eca	Merge pull request #584 from peter-evans/update-distribution Update distribution	2020-09-17 10:39:30 +09:00
peter-evans	eb13e17e17	build: update distribution	2020-09-17 01:38:44 +00:00
Peter Evans	a1ecc20658	Merge pull request #565 from peter-evans/update-dependencies Update dependencies	2020-09-17 10:36:25 +09:00
actions-bot	ffcad23634	chore: update dependencies	2020-09-17 01:15:53 +00:00
Peter Evans	f4b52b768a	Merge pull request #574 from peter-evans/update-distribution Update distribution	2020-09-13 15:13:25 +09:00
peter-evans	af682c8fcb	build: update distribution	2020-09-13 06:11:21 +00:00
Peter Evans	7378b23cb0	Merge pull request #569 from peter-evans/dependabot/npm_and_yarn/node-fetch-2.6.1 Bump node-fetch from 2.6.0 to 2.6.1	2020-09-13 15:08:27 +09:00
dependabot[bot]	370ae6d537	Bump node-fetch from 2.6.0 to 2.6.1 Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1. - [Release notes](https://github.com/bitinn/node-fetch/releases) - [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md) - [Commits](https://github.com/bitinn/node-fetch/compare/v2.6.0...v2.6.1) Signed-off-by: dependabot[bot] <support@github.com>	2020-09-12 21:49:56 +00:00
Peter Evans	ae0797ee12	ci: update commit message type	2020-09-07 17:25:24 +09:00
Peter Evans	e05457394a	ci: update commit messages	2020-09-07 15:26:59 +09:00
Peter Evans	44f76dd5b3	Merge pull request #558 from peter-evans/update-distribution Update distribution	2020-09-07 09:30:37 +09:00
peter-evans	279e66ed27	Update distribution	2020-09-07 00:29:59 +00:00
Peter Evans	ce9dd3641e	Merge pull request #511 from peter-evans/update-dependencies Update dependencies	2020-09-07 09:27:33 +09:00
actions-bot	1a00b34382	Update dependencies	2020-09-07 09:18:17 +09:00
Peter Evans	e17bb55cb7	Merge pull request #547 from peter-evans/delete-branch feat: add input for branch delete	2020-09-07 09:14:08 +09:00
Peter Evans	1890e1ec35	Merge pull request #537 from peter-evans/squash-merge-fix fix: reset branches to handle squash merge	2020-09-07 09:10:33 +09:00
Peter Evans	a49ee3308e	feat: add input for branch delete	2020-09-06 10:21:35 +09:00
Peter Evans	16fa12ee5f	fix: reset branches to handle squash merge	2020-09-06 08:55:33 +09:00
Peter Evans	5ea31358e9	docs: updates related to checkout	2020-09-01 09:15:45 +09:00
Peter Evans	105f0d3816	docs: update examples	2020-08-30 15:17:23 +09:00
Peter Evans	8fb2374109	docs: update readme	2020-08-30 11:20:42 +09:00
Peter Evans	a68328a1ee	docs: update concepts-guidelines	2020-08-30 11:06:03 +09:00
Peter Evans	9bf4b302a5	Merge pull request #526 from peter-evans/detached-head feat: support checkout on a commit in addition to a ref	2020-08-30 10:02:44 +09:00
Peter Evans	da6a868b86	docs: update readme	2020-08-30 09:55:17 +09:00
Peter Evans	cbd5e97fef	docs: update concepts-guidelines	2020-08-30 09:55:07 +09:00
Peter Evans	095c53659b	feat: support checkout on a commit in addition to a ref	2020-08-29 17:28:46 +09:00
Peter Evans	fc687f898b	docs: update examples	2020-08-25 12:18:25 +09:00
Peter Evans	3b32bfa4f7	Merge pull request #517 from peter-evans/update-ncc Change zeit to vercel	2020-08-22 11:51:38 +09:00
Peter Evans	9c3bf74d10	Change zeit to vercel	2020-08-22 11:42:42 +09:00
Peter Evans	b9ed02107c	Update documentation	2020-08-22 11:11:38 +09:00
Peter Evans	2f31350598	Remove unused slash command	2020-08-20 14:31:41 +09:00
Peter Evans	d14206169d	Update documentation	2020-08-19 18:29:04 +09:00
Peter Evans	82c423c73b	Merge pull request #508 from peter-evans/update-distribution Update distribution	2020-08-19 17:40:53 +09:00
peter-evans	7cf22579c6	Update distribution	2020-08-19 08:39:31 +00:00
Peter Evans	5893420513	Merge pull request #503 from peter-evans/not-updated-fix Fix pr create/update for already up to date branches	2020-08-19 17:37:01 +09:00
Peter Evans	8bdec9b230	Fix pr create/update for already up to date branches	2020-08-19 17:08:59 +09:00