Merge pull request #394 from peter-evans/update-distribution

Update distribution

.eslintignore

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

.eslintrc.json

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

.github/CODEOWNERS

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

.github/ISSUE_TEMPLATE.md

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

.github/workflows/ci.yml

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

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

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

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

@@ -1,40 +0,0 @@
-on:
-  repository_dispatch:
-    types: [create-pull-request-multi]
-name: create-pull-request workflow
-jobs:
-  createPullRequest:
-    name: Testing on ${{ matrix.platform }}
-    strategy:
-      matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
-    runs-on: ${{ matrix.platform }}
-    steps:
-      - uses: actions/checkout@v1
-      - name: Create report file
-        if:  matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
-        run: date +%s > report.txt
-      - name: Create report file (windows)
-        if:  matrix.platform == 'windows-latest'
-        run: echo %DATE% %TIME% > report.txt
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@multi-platform-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COMMIT_MESSAGE: Add report file
-          PULL_REQUEST_BODY: >
-            This PR is auto-generated by 
-            [create-pull-request](https://github.com/peter-evans/create-pull-request).
-          PULL_REQUEST_TITLE: '[Example] Add report file'
-          PULL_REQUEST_LABELS: report, automated pr
-          PULL_REQUEST_ASSIGNEES: peter-evans
-          PULL_REQUEST_REVIEWERS: peter-evans
-          PULL_REQUEST_MILESTONE: 1
-          PULL_REQUEST_BRANCH: example-patches
-          BRANCH_SUFFIX: 'random'
-      - name: Check output environment variable
-        if:  matrix.platform == 'ubuntu-latest' || matrix.platform == 'macos-latest'
-        run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"
-      - name: Check output environment variable (windows)
-        if:  matrix.platform == 'windows-latest'
-        run: echo Pull Request Number - %PULL_REQUEST_NUMBER%

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

@@ -1,28 +0,0 @@
-on:
-  repository_dispatch:
-    types: [create-pull-request]
-name: create-pull-request workflow
-jobs:
-  createPullRequest:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: Create report file
-        run: date +%s > report.txt
-      - name: Create Pull Request
-        uses: ./
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COMMIT_MESSAGE: Add report file
-          PULL_REQUEST_BODY: >
-            This PR is auto-generated by 
-            [create-pull-request](https://github.com/peter-evans/create-pull-request).
-          PULL_REQUEST_TITLE: '[Example] Add report file'
-          PULL_REQUEST_LABELS: report, automated pr
-          PULL_REQUEST_ASSIGNEES: peter-evans
-          PULL_REQUEST_REVIEWERS: peter-evans
-          PULL_REQUEST_MILESTONE: 1
-          PULL_REQUEST_BRANCH: example-patches
-          BRANCH_SUFFIX: short-commit-hash
-      - name: Check output environment variable
-        run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"

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

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

.github/workflows/update-dep.yml

@@ -0,0 +1,31 @@
+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@v2
+        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

.gitignore

@@ -1 +1,7 @@
+__pycache__
+.python-version
+
+lib/
+node_modules/
+
 .DS_Store

.prettierignore

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

.prettierrc.json

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

Dockerfile

@@ -1,20 +0,0 @@
-FROM alpine:3.10.2
-
-LABEL maintainer="Peter Evans <mail@peterevans.dev>"
-LABEL repository="https://github.com/peter-evans/create-pull-request"
-LABEL homepage="https://github.com/peter-evans/create-pull-request"
-
-LABEL com.github.actions.name="Create Pull Request"
-LABEL com.github.actions.description="Creates a pull request for changes to your repository in the actions workspace"
-LABEL com.github.actions.icon="git-pull-request"
-LABEL com.github.actions.color="gray-dark"
-
-COPY LICENSE README.md /
-
-RUN apk add python3-dev git git-lfs
-
-COPY requirements.txt /tmp/
-RUN pip3 install --requirement /tmp/requirements.txt
-
-COPY create-pull-request.py /create-pull-request.py
-ENTRYPOINT [ "/create-pull-request.py" ]

README.md

@@ -1,4 +1,5 @@
-# <img width="24" height="24" src="logo.svg"> Create Pull Request
+# <img width="24" height="24" src="docs/assets/logo.svg"> Create Pull Request
+[![CI](https://github.com/peter-evans/create-pull-request/workflows/CI/badge.svg)](https://github.com/peter-evans/create-pull-request/actions?query=workflow%3ACI)
 [![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Create%20Pull%20Request-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/create-pull-request)
 
 A GitHub action to create a pull request for changes to your repository in the actions workspace.
@@ -9,113 +10,214 @@ The changes will be automatically committed to a new branch and a pull request c
 
 Create Pull Request action will:
 
-1. Check for repository changes in the Actions workspace. This includes untracked (new) files as well as modified files.
-2. Commit all changes to a new branch, or update an existing pull request branch. The commit will be made using the name and email of the `HEAD` commit author.
-3. Create a pull request to merge the new branch into the currently active branch executing the workflow.
+1. Check for repository changes in the Actions workspace. This includes:
+   - untracked (new) files
+   - tracked (modified) files
+   - commits made during the workflow that have not been pushed
+2. Commit all changes to a new branch, or update an existing pull request branch.
+3. Create a pull request to merge the new branch into the base&mdash;the branch checked out in the workflow.
+
+## Documentation
+
+- [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md)
+- [Examples](docs/examples.md)
+- [Updating from v1](docs/updating.md)
 
 ## Usage
 
-Linux
 ```yml
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.4.0
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: peter-evans/create-pull-request@v2
 ```
 
-Multi platform - Linux, MacOS, Windows (beta)
+You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format `@v2.x.x`
+
+### Action inputs
+
+All inputs are **optional**. If not set, sensible default values will be used.
+
+**Note**: If you want pull requests created by this action to trigger an `on: push` or `on: pull_request` workflow then you cannot use the default `GITHUB_TOKEN`. See the [documentation here](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#triggering-further-workflow-runs) for workarounds.
+
+| Name | Description | Default |
+| --- | --- | --- |
+| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | `GITHUB_TOKEN` |
+| `path` | Relative path under `GITHUB_WORKSPACE` to the repository. | `GITHUB_WORKSPACE` |
+| `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. See [Committer and author](#committer-and-author) for details. |
+| `author` | The author name and email address in the format `Display Name <email@address.com>`. | Defaults to the GitHub Actions bot user. See [Committer and author](#committer-and-author) for details. |
+| `title` | The title of the pull request. | `Changes by create-pull-request action` |
+| `body` | The body of the pull request. | `Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action` |
+| `labels` | A comma separated list of labels. | |
+| `assignees` | A comma separated list of assignees (GitHub usernames). | |
+| `reviewers` | A comma separated list of reviewers (GitHub usernames) to request a review from. | |
+| `team-reviewers` | A comma separated list of GitHub teams to request a review from. A `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). | |
+| `milestone` | The number of the milestone to associate this pull request with. | |
+| `project` | *Deprecated*. See [Create a project card](#create-a-project-card) for details. | |
+| `project-column` | *Deprecated*. See [Create a project card](#create-a-project-card) for details. | |
+| `draft` | Create a [draft pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` |
+| `branch` | The branch name. See [Action behaviour](#action-behaviour) for details. | `create-pull-request/patch` |
+| `request-to-parent` | Create the pull request in the parent repository of the checked out fork. See [push pull request branches to a fork](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#push-pull-request-branches-to-a-fork) for details. | `false` |
+| `base` | Sets the pull request base branch. | Defaults to the branch checked out in the workflow. |
+| `branch-suffix` | The branch suffix type. Valid values are `random`, `timestamp` and `short-commit-hash`. See [Action behaviour](#action-behaviour) for details. | |
+
+### Action outputs
+
+The pull request number is output as both an environment variable and a step output.
+Note that in order to read the step output the action step must have an id.
+
 ```yml
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.4.0-multi
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        id: cpr
+        uses: peter-evans/create-pull-request@v2
+      - name: Check outputs
+        run: |
+          echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
 ```
 
-### Environment variables
+### Checkout
 
-These variables are all optional. If not set, a default value will be used.
+This action expects repositories to be checked out with `actions/checkout@v2`.
 
-- `COMMIT_MESSAGE` - The message to use when committing changes.
-- `PULL_REQUEST_TITLE` - The title of the pull request.
-- `PULL_REQUEST_BODY` - The body of the pull request.
-- `PULL_REQUEST_LABELS` - A comma separated list of labels.
-- `PULL_REQUEST_ASSIGNEES` - A comma separated list of assignees (GitHub usernames).
-- `PULL_REQUEST_REVIEWERS` - A comma separated list of reviewers (GitHub usernames) to request a review from.
-- `PULL_REQUEST_TEAM_REVIEWERS` - A comma separated list of GitHub teams to request a review from.
-- `PULL_REQUEST_MILESTONE` - The number of the milestone to associate this pull request with.
-- `PULL_REQUEST_BRANCH` - The branch name. See **Branch naming** below for details.
-- `BRANCH_SUFFIX` - The branch suffix type. Valid values are `short-commit-hash` (default), `timestamp`, `random` and `none`. See **Branch naming** below for details.
+If there is some reason you need to use `actions/checkout@v1` the following step can be added to checkout the branch.
 
-Output environment variables
+```yml
+      - uses: actions/checkout@v1
+      - run: git checkout "${GITHUB_REF:11}"
+```
 
-- `PULL_REQUEST_NUMBER` - The number of the pull request created.
+### Action behaviour
 
-The following parameters are available for debugging and troubleshooting.
+The default behaviour of the action is to create a pull request that will be continually updated with new changes until it is merged or closed.
+Changes are committed and pushed to a fixed-name branch, the name of which can be configured with the `branch` input.
+Any subsequent changes will be committed to the *same* branch and reflected in the open pull request.
 
-- `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow.
-- `SKIP_IGNORE` - If present, the `ignore_event` function will be skipped.
+How the action behaves:
 
-### Branch naming
+- 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.
 
-For branch naming there are two strategies. Always create a new branch each time there are changes to be committed, OR, create a fixed-name pull request branch that will be updated with any new commits until it is merged or closed.
+For further details about how the action works and usage guidelines, see [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md).
 
-#### Strategy A - Always create a new pull request branch (default)
+#### Alternative strategy - Always create a new pull request branch
 
-For this strategy there are three options to suffix the branch name.
-The branch name is defined by the variable `PULL_REQUEST_BRANCH` and defaults to `create-pull-request/patch`. The following options are values for `BRANCH_SUFFIX`.
+For some use cases it *may* be desirable to always create a new unique branch each time there are changes to be committed.
+This strategy is not recommended and mainly kept for backwards compatibility.
 
-- `short-commit-hash` (default) - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
+To use this strategy, set input `branch-suffix` with one of the following options.
+
+- `random` - Commits will be made to a branch suffixed with a random alpha-numeric string. e.g. `create-pull-request/patch-6qj97jr`, `create-pull-request/patch-5jrjhvd`
 
 - `timestamp` - Commits will be made to a branch suffixed by a timestamp. e.g. `create-pull-request/patch-1569322532`, `create-pull-request/patch-1569322552`
 
-- `random` - Commits will be made to a branch suffixed with a random alpha-numeric string. This option should be used if multiple pull requests will be created during the execution of a workflow. e.g. `create-pull-request/patch-6qj97jr`, `create-pull-request/patch-5jrjhvd`
-
-#### Strategy B - Create and update a pull request branch
-
-To use this strategy, set `BRANCH_SUFFIX` to the value `none`. The variable `PULL_REQUEST_BRANCH` defaults to `create-pull-request/patch`. Commits will be made to this branch and a pull request created. Any subsequent changes will be committed to the *same* branch and reflected in the existing pull request.
+- `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`
 
 ### 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.
 
-## Example
+### Committer and author
 
-Here is an example that sets all the main environment variables.
+If neither `committer` or `author` inputs are supplied the action will default to making commits that appear to be made by the GitHub Actions bot user.
+
+The following configuration can be used to have commits authored by the user who triggered the workflow event.
+```yml
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+        with:
+          committer: GitHub <noreply@github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+```
+
+### Controlling commits
+
+As well as relying on the action to handle uncommitted changes, you can additionally make your own commits before the action runs.
 
 ```yml
-on:
-  repository_dispatch:
-    types: [create-pull-request]
-name: create-pull-request workflow
+    steps:
+      - uses: actions/checkout@v2
+      - name: Create commits
+        run: |
+          git config user.name 'Peter Evans'
+          git config user.email 'peter-evans@users.noreply.github.com'
+          date +%s > report.txt
+          git commit -am "Modify tracked file during workflow"
+          date +%s > new-report.txt
+          git add -A
+          git commit -m "Add untracked file during workflow"
+      - name: Uncommitted change
+        run: date +%s > report.txt
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+```
+
+### Create a project card
+
+To create a project card for the pull request, pass the `pull-request-number` step output to [create-or-update-project-card](https://github.com/peter-evans/create-or-update-project-card) action.
+
+```yml
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v2
+
+      - name: Create or Update Project Card
+        uses: peter-evans/create-or-update-project-card@v1
+        with:
+          project-name: My project
+          column-name: My column
+          issue-number: ${{ steps.cpr.outputs.pull-request-number }}
+```
+
+## Reference Example
+
+The following workflow is a reference example that sets all the main inputs.
+
+See [examples](docs/examples.md) for more realistic use cases.
+
+```yml
+name: Create Pull Request
+on: push
 jobs:
   createPullRequest:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
       - name: Create report file
         run: date +%s > report.txt
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v1.4.0
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          COMMIT_MESSAGE: Add report file
-          PULL_REQUEST_BODY: >
-            This PR is auto-generated by 
-            [create-pull-request](https://github.com/peter-evans/create-pull-request).
-          PULL_REQUEST_TITLE: '[Example] Add report file'
-          PULL_REQUEST_LABELS: report, automated pr
-          PULL_REQUEST_ASSIGNEES: peter-evans
-          PULL_REQUEST_REVIEWERS: peter-evans
-          PULL_REQUEST_MILESTONE: 1
-          PULL_REQUEST_BRANCH: example-patches
-          BRANCH_SUFFIX: short-commit-hash
-      - name: Check output environment variable
-        run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"
+        id: cpr
+        uses: peter-evans/create-pull-request@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Add report file
+          committer: GitHub <noreply@github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          title: '[Example] Add report file'
+          body: |
+            New report
+            - Contains *today's* date
+            - Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          labels: report, automated pr
+          assignees: peter-evans
+          reviewers: peter-evans
+          team-reviewers: owners, maintainers
+          milestone: 1
+          draft: false
+          branch: example-patches
+          request-to-parent: false
+      - name: Check outputs
+        run: |
+          echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
 ```
 
-This configuration will create pull requests that look like this:
+An example based on the above reference configuration creates pull requests that look like this:
 
-![Pull Request Example](pull-request-example.png?raw=true)
+![Pull Request Example](docs/assets/pull-request-example.png)
 
 ## License
 

__test__/entrypoint.sh

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

__test__/git.int.test.ts

@@ -0,0 +1,153 @@
+import {
+  getRepoPath,
+  execGit,
+  addConfigOption,
+  unsetConfigOption,
+  configOptionExists,
+  getConfigOption,
+  getAndUnsetConfigOption
+} from '../lib/git'
+
+const originalGitHubWorkspace = process.env['GITHUB_WORKSPACE']
+
+describe('git tests', () => {
+  beforeAll(() => {
+    // GitHub workspace
+    process.env['GITHUB_WORKSPACE'] = '/git/test-repo'
+  })
+
+  afterAll(() => {
+    // Restore GitHub workspace
+    delete process.env['GITHUB_WORKSPACE']
+    if (originalGitHubWorkspace) {
+      process.env['GITHUB_WORKSPACE'] = originalGitHubWorkspace
+    }
+  })
+
+  it('successfully executes a git command', async () => {
+    const repoPath = getRepoPath()
+    const result = await execGit(
+      repoPath,
+      ['config', '--local', '--name-only', '--get-regexp', 'remote.origin.url'],
+      true
+    )
+    expect(result.exitCode).toEqual(0)
+    expect(result.stdout.trim()).toEqual('remote.origin.url')
+  })
+
+  it('adds and unsets a config option', async () => {
+    const repoPath = getRepoPath()
+    const add = await addConfigOption(
+      repoPath,
+      'test.add.and.unset.config.option',
+      'foo'
+    )
+    expect(add).toBeTruthy()
+    const unset = await unsetConfigOption(
+      repoPath,
+      'test.add.and.unset.config.option'
+    )
+    expect(unset).toBeTruthy()
+  })
+
+  it('adds and unsets a config option with value regex', async () => {
+    const repoPath = getRepoPath()
+    const add = await addConfigOption(
+      repoPath,
+      'test.add.and.unset.config.option',
+      'foo bar'
+    )
+    expect(add).toBeTruthy()
+    const unset = await unsetConfigOption(
+      repoPath,
+      'test.add.and.unset.config.option',
+      '^foo'
+    )
+    expect(unset).toBeTruthy()
+  })
+
+  it('determines that a config option exists', async () => {
+    const repoPath = getRepoPath()
+    const result = await configOptionExists(repoPath, 'remote.origin.url')
+    expect(result).toBeTruthy()
+  })
+
+  it('determines that a config option does not exist', async () => {
+    const repoPath = getRepoPath()
+    const result = await configOptionExists(repoPath, 'this.key.does.not.exist')
+    expect(result).toBeFalsy()
+  })
+
+  it('successfully retrieves a config option', async () => {
+    const repoPath = getRepoPath()
+    const add = await addConfigOption(repoPath, 'test.get.config.option', 'foo')
+    expect(add).toBeTruthy()
+    const option = await getConfigOption(repoPath, 'test.get.config.option')
+    expect(option.value).toEqual('foo')
+    const unset = await unsetConfigOption(repoPath, 'test.get.config.option')
+    expect(unset).toBeTruthy()
+  })
+
+  it('gets a config option with value regex', async () => {
+    const repoPath = getRepoPath()
+    const add = await addConfigOption(
+      repoPath,
+      'test.get.config.option',
+      'foo bar'
+    )
+    expect(add).toBeTruthy()
+    const option = await getConfigOption(
+      repoPath,
+      'test.get.config.option',
+      '^foo'
+    )
+    expect(option.value).toEqual('foo bar')
+    const unset = await unsetConfigOption(
+      repoPath,
+      'test.get.config.option',
+      '^foo'
+    )
+    expect(unset).toBeTruthy()
+  })
+
+  it('gets and unsets a config option', async () => {
+    const repoPath = getRepoPath()
+    const add = await addConfigOption(
+      repoPath,
+      'test.get.and.unset.config.option',
+      'foo'
+    )
+    expect(add).toBeTruthy()
+    const getAndUnset = await getAndUnsetConfigOption(
+      repoPath,
+      'test.get.and.unset.config.option'
+    )
+    expect(getAndUnset.value).toEqual('foo')
+  })
+
+  it('gets and unsets a config option with value regex', async () => {
+    const repoPath = getRepoPath()
+    const add = await addConfigOption(
+      repoPath,
+      'test.get.and.unset.config.option',
+      'foo bar'
+    )
+    expect(add).toBeTruthy()
+    const getAndUnset = await getAndUnsetConfigOption(
+      repoPath,
+      'test.get.and.unset.config.option',
+      '^foo'
+    )
+    expect(getAndUnset.value).toEqual('foo bar')
+  })
+
+  it('fails to get and unset a config option', async () => {
+    const repoPath = getRepoPath()
+    const getAndUnset = await getAndUnsetConfigOption(
+      repoPath,
+      'this.key.does.not.exist'
+    )
+    expect(getAndUnset.name).toEqual('')
+    expect(getAndUnset.value).toEqual('')
+  })
+})

__test__/git.unit.test.ts

@@ -0,0 +1,26 @@
+import * as path from 'path'
+import {getRepoPath} from '../lib/git'
+
+const originalGitHubWorkspace = process.env['GITHUB_WORKSPACE']
+
+describe('git tests', () => {
+  beforeAll(() => {
+    // GitHub workspace
+    process.env['GITHUB_WORKSPACE'] = __dirname
+  })
+
+  afterAll(() => {
+    // Restore GitHub workspace
+    delete process.env['GITHUB_WORKSPACE']
+    if (originalGitHubWorkspace) {
+      process.env['GITHUB_WORKSPACE'] = originalGitHubWorkspace
+    }
+  })
+
+  test('getRepoPath', async () => {
+    expect(getRepoPath()).toEqual(process.env['GITHUB_WORKSPACE'])
+    expect(getRepoPath('foo')).toEqual(
+      path.resolve(process.env['GITHUB_WORKSPACE'] || '', 'foo')
+    )
+  })
+})

__test__/integration-tests.sh

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

action.yml

@@ -1,9 +1,52 @@
 name: 'Create Pull Request'
-author: 'Peter Evans'
 description: 'Creates a pull request for changes to your repository in the actions workspace'
+inputs:
+  token:
+    description: 'GITHUB_TOKEN or a repo scoped PAT'
+    default: ${{ github.token }}
+  path:
+    description: 'Relative path under $GITHUB_WORKSPACE to the repository.'
+  commit-message:
+    description: 'The message to use when committing changes.'
+  committer:
+    description: 'The committer name and email address.'
+  author:
+    description: 'The author name and email address.'
+  title:
+    description: 'The title of the pull request.'
+  body:
+    description: 'The body of the pull request.'
+  labels:
+    description: 'A comma separated list of labels.'
+  assignees:
+    description: 'A comma separated list of assignees (GitHub usernames).'
+  reviewers:
+    description: 'A comma separated list of reviewers (GitHub usernames) to request a review from.'
+  team-reviewers:
+    description: 'A comma separated list of GitHub teams to request a review from.'
+  milestone:
+    description: 'The number of the milestone to associate this pull request with.'
+  project:
+    description: 'Deprecated. See README for details.'
+  project-column:
+    description: 'Deprecated. See README for details.'
+  draft:
+    description: 'Create a draft pull request'
+  branch:
+    description: 'The pull request branch name.'
+  request-to-parent:
+    description: 'Create the pull request in the parent repository of the checked out fork.'
+    default: false
+  base:
+    description: 'The pull request base branch.'
+  branch-suffix:
+    description: 'The branch suffix type.'
+outputs:
+  pull-request-number:
+    description: 'The pull request number'
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: 'node12'
+  main: 'dist/index.js'
 branding:
-  icon: 'git-pull-request'  
+  icon: 'git-pull-request'
   color: 'gray-dark'

create-pull-request.py

@@ -1,218 +0,0 @@
-#!/usr/bin/env python3
-''' Create Pull Request '''
-import json
-import os
-import random
-import string
-import sys
-import time
-from git import Repo
-from github import Github
-
-
-def get_github_event(github_event_path):
-    with open(github_event_path) as f:
-        github_event = json.load(f)
-    if bool(os.environ.get('DEBUG_EVENT')):
-        print(os.environ['GITHUB_EVENT_NAME'])
-        print(json.dumps(github_event, sort_keys=True, indent=2))
-    return github_event
-
-
-def ignore_event(event_name, event_data):
-    if event_name == "push":
-        # Ignore push events on deleted branches
-        # The event we want to ignore occurs when a PR is created but the repository owner decides
-        # not to commit the changes. They close the PR and delete the branch. This creates a 
-        # "push" event that we want to ignore, otherwise it will create another branch and PR on
-        # the same commit.
-        deleted = "{deleted}".format(**event_data)
-        if deleted == "True":
-            print("Ignoring delete branch event.")
-            return True
-        ref = "{ref}".format(**event_data)
-        if not ref.startswith('refs/heads/'):
-            print("Ignoring events for tags and remotes.")
-            return True
-    return False
-
-
-def get_head_short_sha1(repo):
-    return repo.git.rev_parse('--short', 'HEAD')
-
-
-def get_random_suffix(size=7, chars=string.ascii_lowercase + string.digits):
-    return ''.join(random.choice(chars) for _ in range(size))
-
-
-def remote_branch_exists(repo, branch):
-    for ref in repo.remotes.origin.refs:
-        if ref.name == ("origin/%s" % branch):
-            return True
-    return False
-
-
-def get_head_author(event_name, event_data):
-    if event_name == "push":
-        email = "{head_commit[author][email]}".format(**event_data)
-        name = "{head_commit[author][name]}".format(**event_data)
-    else:
-        email = os.environ['GITHUB_ACTOR'] + '@users.noreply.github.com'
-        name = os.environ['GITHUB_ACTOR']
-    return email, name
-
-
-def set_git_config(git, email, name):
-    git.config('--global', 'user.email', '"%s"' % email)
-    git.config('--global', 'user.name', '"%s"' % name)
-
-
-def set_git_remote_url(git, token, github_repository):
-    git.remote('set-url', 'origin', "https://x-access-token:%s@github.com/%s" % (token, github_repository))
-
-
-def checkout_branch(git, remote_exists, branch):
-    if remote_exists:
-        git.stash('--include-untracked')
-        git.checkout(branch)
-        try:
-            git.stash('pop')
-        except:
-            git.checkout('--theirs', '.')
-            git.reset()
-    else:
-        git.checkout('HEAD', b=branch)
-
-
-def push_changes(git, branch, commit_message):
-    git.add('-A')
-    git.commit(m=commit_message)
-    return git.push('-f', '--set-upstream', 'origin', branch)
-
-
-def cs_string_to_list(str):
-    # Split the comma separated string into a list
-    l = [i.strip() for i in str.split(',')]
-    # Remove empty strings
-    return list(filter(None, l))
-
-
-def process_event(event_name, event_data, repo, branch, base, remote_exists):
-    # Fetch required environment variables
-    github_token = os.environ['GITHUB_TOKEN']
-    github_repository = os.environ['GITHUB_REPOSITORY']
-    # Fetch optional environment variables with default values
-    commit_message = os.getenv(
-        'COMMIT_MESSAGE',
-        "Auto-committed changes by create-pull-request action")
-    title = os.getenv(
-        'PULL_REQUEST_TITLE',
-        "Auto-generated by create-pull-request action")
-    body = os.getenv(
-        'PULL_REQUEST_BODY', "Auto-generated pull request by "
-        "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action")
-    # Fetch optional environment variables with no default values
-    pull_request_labels = os.environ.get('PULL_REQUEST_LABELS')
-    pull_request_assignees = os.environ.get('PULL_REQUEST_ASSIGNEES')
-    pull_request_milestone = os.environ.get('PULL_REQUEST_MILESTONE')
-    pull_request_reviewers = os.environ.get('PULL_REQUEST_REVIEWERS')
-    pull_request_team_reviewers = os.environ.get('PULL_REQUEST_TEAM_REVIEWERS')
-
-    # Update URL for the 'origin' remote
-    set_git_remote_url(repo.git, github_token, github_repository)
-
-    # Push the local changes to the remote branch
-    print("Pushing changes.")
-    push_result = push_changes(repo.git, branch, commit_message)
-    print(push_result)
-
-    # If the remote existed then a PR likely exists and we can finish here
-    if remote_exists:
-        print("Updated pull request branch %s." % branch)
-        sys.exit()
-
-    # Create the pull request
-    print("Creating a request to pull %s into %s." % (branch, base))
-    github_repo = Github(github_token).get_repo(github_repository)
-    pull_request = github_repo.create_pull(
-        title=title,
-        body=body,
-        base=base,
-        head=branch)
-    print("Created pull request %d." % pull_request.number)
-    os.system('echo ::set-env name=PULL_REQUEST_NUMBER::%d' % pull_request.number)
-
-    # Set labels, assignees and milestone
-    if pull_request_labels is not None:
-        print("Applying labels")
-        pull_request.as_issue().edit(labels=cs_string_to_list(pull_request_labels))
-    if pull_request_assignees is not None:
-        print("Applying assignees")
-        pull_request.as_issue().edit(assignees=cs_string_to_list(pull_request_assignees))
-    if pull_request_milestone is not None:
-        print("Applying milestone")
-        milestone = github_repo.get_milestone(int(pull_request_milestone))
-        pull_request.as_issue().edit(milestone=milestone)
-
-    # Set pull request reviewers and team reviewers
-    if pull_request_reviewers is not None:
-        print("Requesting reviewers")
-        pull_request.create_review_request(reviewers=cs_string_to_list(pull_request_reviewers))
-    if pull_request_team_reviewers is not None:
-        print("Requesting team reviewers")
-        pull_request.create_review_request(team_reviewers=cs_string_to_list(pull_request_team_reviewers))
-
-
-# Get the JSON event data
-event_name = os.environ['GITHUB_EVENT_NAME']
-event_data = get_github_event(os.environ['GITHUB_EVENT_PATH'])
-# Check if this event should be ignored
-skip_ignore_event = bool(os.environ.get('SKIP_IGNORE'))
-if skip_ignore_event or not ignore_event(event_name, event_data):
-    # Set the repo to the working directory
-    repo = Repo(os.getcwd())
-
-    # Fetch/Set the branch name
-    branch = os.getenv('PULL_REQUEST_BRANCH', 'create-pull-request/patch')
-    # Set the current branch as the target base branch
-    base = os.environ['GITHUB_REF'][11:]
-
-    # Skip if the current branch is a PR branch created by this action
-    if base.startswith(branch):
-        print("Branch '%s' was created by this action. Skipping." % base)
-        sys.exit()
-
-    # Fetch an optional environment variable to determine the branch suffix
-    branch_suffix = os.getenv('BRANCH_SUFFIX', 'short-commit-hash')
-    if branch_suffix == "short-commit-hash":
-        # Suffix with the short SHA1 hash
-        branch = "%s-%s" % (branch, get_head_short_sha1(repo))
-    elif branch_suffix == "timestamp":
-        # Suffix with the current timestamp
-        branch = "%s-%s" % (branch, int(time.time()))
-    elif branch_suffix == "random":
-        # Suffix with the current timestamp
-        branch = "%s-%s" % (branch, get_random_suffix())
-
-    # Check if the remote branch exists
-    remote_exists = remote_branch_exists(repo, branch)
-
-    # If using short commit hash prefixes, check if a remote 
-    # branch already exists for this HEAD commit
-    if branch_suffix == 'short-commit-hash' and remote_exists:
-        print("Pull request branch '%s' already exists for this commit. Skipping." % branch)
-        sys.exit()
-
-    # Get the HEAD committer's email and name
-    author_email, author_name = get_head_author(event_name, event_data)
-    # Set git configuration
-    set_git_config(repo.git, author_email, author_name)
-    # Checkout branch
-    checkout_branch(repo.git, remote_exists, branch)
-
-    # Check if there are changes to pull request
-    if repo.is_dirty() or len(repo.untracked_files) > 0:
-        print("Repository has modified or untracked files.")
-        process_event(event_name, event_data, repo, branch, base, remote_exists)
-    else:
-        print("Repository has no modified or untracked files. Skipping.")

dist/cpr/common.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+import random
+import re
+import string
+
+
+def get_random_string(length=7, chars=string.ascii_lowercase + string.digits):
+    return "".join(random.choice(chars) for _ in range(length))
+
+
+def parse_github_repository(url):
+    # Parse the protocol and github repository from a URL
+    # e.g. HTTPS, peter-evans/create-pull-request
+    https_pattern = re.compile(r"^https://.*@?github.com/(.+/.+)$")
+    ssh_pattern = re.compile(r"^git@github.com:(.+/.+).git$")
+
+    match = https_pattern.match(url)
+    if match is not None:
+        return "HTTPS", match.group(1)
+
+    match = ssh_pattern.match(url)
+    if match is not None:
+        return "SSH", match.group(1)
+
+    raise ValueError(f"The format of '{url}' is not a valid GitHub repository URL")
+
+
+def parse_display_name_email(display_name_email):
+    # Parse the name and email address from a string in the following format
+    # Display Name <email@address.com>
+    pattern = re.compile(r"^([^<]+)\s*<([^>]+)>$")
+
+    # Check we have a match
+    match = pattern.match(display_name_email)
+    if match is None:
+        raise ValueError(
+            f"The format of '{display_name_email}' is not a valid email address with display name"
+        )
+
+    # Check that name and email are not just whitespace
+    name = match.group(1).strip()
+    email = match.group(2).strip()
+    if len(name) == 0 or len(email) == 0:
+        raise ValueError(
+            f"The format of '{display_name_email}' is not a valid email address with display name"
+        )
+
+    return name, email

dist/cpr/create_or_update_branch.py

@@ -0,0 +1,145 @@
+#!/usr/bin/env python3
+""" Create or Update Branch """
+import common as cmn
+from git import Repo, GitCommandError
+import os
+
+
+CHERRYPICK_EMPTY = (
+    "The previous cherry-pick is now empty, possibly due to conflict resolution."
+)
+
+
+def fetch_successful(repo, repo_url, branch):
+    try:
+        repo.git.fetch(repo_url, f"{branch}:refs/remotes/origin/{branch}")
+    except GitCommandError:
+        return False
+    return True
+
+
+def is_ahead(repo, branch_1, branch_2):
+    # Return true if branch_2 is ahead of branch_1
+    return (
+        int(repo.git.rev_list("--right-only", "--count", f"{branch_1}...{branch_2}"))
+        > 0
+    )
+
+
+def is_behind(repo, branch_1, branch_2):
+    # Return true if branch_2 is behind branch_1
+    return (
+        int(repo.git.rev_list("--left-only", "--count", f"{branch_1}...{branch_2}")) > 0
+    )
+
+
+def is_even(repo, branch_1, branch_2):
+    # Return true if branch_2 is even with branch_1
+    return not is_ahead(repo, branch_1, branch_2) and not is_behind(
+        repo, branch_1, branch_2
+    )
+
+
+def has_diff(repo, branch_1, branch_2):
+    diff = repo.git.diff(f"{branch_1}..{branch_2}")
+    return len(diff) > 0
+
+
+def create_or_update_branch(repo, repo_url, commit_message, base, branch):
+    # Set the default return values
+    action = "none"
+    diff = False
+
+    # Get the working base. This may or may not be the actual base.
+    working_base = repo.git.symbolic_ref("HEAD", "--short")
+    # If the base is not specified it is assumed to be the working base
+    if base is None:
+        base = working_base
+
+    # Save the working base changes to a temporary branch
+    temp_branch = cmn.get_random_string(length=20)
+    repo.git.checkout("HEAD", b=temp_branch)
+    # Commit any uncomitted changes
+    if repo.is_dirty(untracked_files=True):
+        print(f"Uncommitted changes found. Adding a commit.")
+        repo.git.add("-A")
+        repo.git.commit(m=commit_message)
+
+    # Perform fetch and reset the working base
+    # Commits made during the workflow will be removed
+    repo.git.fetch("--force", repo_url, f"{working_base}:{working_base}")
+
+    # If the working base is not the base, rebase the temp branch commits
+    if working_base != base:
+        print(
+            f"Rebasing commits made to branch '{working_base}' on to base branch '{base}'"
+        )
+        # Checkout the actual base
+        repo.git.fetch("--force", repo_url, f"{base}:{base}")
+        repo.git.checkout(base)
+        # Cherrypick commits from the temporary branch starting from the working base
+        commits = repo.git.rev_list("--reverse", f"{working_base}..{temp_branch}", ".")
+        for commit in commits.splitlines():
+            try:
+                repo.git.cherry_pick(
+                    "--strategy",
+                    "recursive",
+                    "--strategy-option",
+                    "theirs",
+                    f"{commit}",
+                )
+            except GitCommandError as e:
+                if CHERRYPICK_EMPTY not in e.stderr:
+                    print("Unexpected error: ", e)
+                    raise
+        # Reset the temp branch to the working index
+        repo.git.checkout("-B", temp_branch, "HEAD")
+        # Reset the base
+        repo.git.fetch("--force", repo_url, f"{base}:{base}")
+
+    # Try to fetch the pull request branch
+    if not fetch_successful(repo, repo_url, branch):
+        # The pull request branch does not exist
+        print(f"Pull request branch '{branch}' does not exist yet")
+        # Create the pull request branch
+        repo.git.checkout("HEAD", b=branch)
+        # Check if the pull request branch is ahead of the base
+        diff = is_ahead(repo, base, branch)
+        if diff:
+            action = "created"
+            print(f"Created branch '{branch}'")
+        else:
+            print(
+                f"Branch '{branch}' is not ahead of base '{base}' and will not be created"
+            )
+    else:
+        # The pull request branch exists
+        print(
+            f"Pull request branch '{branch}' already exists as remote branch 'origin/{branch}'"
+        )
+        # Checkout the pull request branch
+        repo.git.checkout(branch)
+
+        if has_diff(repo, branch, temp_branch):
+            # 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
+            print(f"Resetting '{branch}'")
+            repo.git.checkout("-B", branch, temp_branch)
+            # repo.git.switch("-C", branch, temp_branch)
+
+        # Check if the pull request branch has been updated
+        # If the branch was reset or updated it will be ahead
+        # It may be behind if a reset now results in no diff with the base
+        if not is_even(repo, f"origin/{branch}", branch):
+            action = "updated"
+            print(f"Updated branch '{branch}'")
+        else:
+            print(f"Branch '{branch}' is even with its remote and will not be updated")
+
+        # Check if the pull request branch is ahead of the base
+        diff = is_ahead(repo, base, branch)
+
+    # Delete the temporary branch
+    repo.git.branch("--delete", "--force", temp_branch)
+
+    return {"action": action, "diff": diff, "base": base}

dist/cpr/create_or_update_pull_request.py

@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+""" Create or Update Pull Request """
+from github import Github, GithubException
+import os
+
+
+def string_to_bool(str):
+    if str is None:
+        return False
+    else:
+        return str.lower() in [
+            "true",
+            "1",
+            "t",
+            "y",
+            "yes",
+            "on",
+        ]
+
+
+def cs_string_to_list(str):
+    # Split the comma separated string into a list
+    l = [i.strip() for i in str.split(",")]
+    # Remove empty strings
+    return list(filter(None, l))
+
+
+def create_project_card(github_repo, project_name, project_column_name, pull_request):
+    # Locate the project by name
+    project = None
+    for project_item in github_repo.get_projects("all"):
+        if project_item.name == project_name:
+            project = project_item
+            break
+
+    if not project:
+        print("::error::Project not found. Unable to create project card.")
+        return
+
+    # Locate the column by name
+    column = None
+    for column_item in project.get_columns():
+        if column_item.name == project_column_name:
+            column = column_item
+            break
+
+    if not column:
+        print("::error::Project column not found. Unable to create project card.")
+        return
+
+    # Create a project card for the pull request
+    column.create_card(content_id=pull_request.id, content_type="PullRequest")
+    print(
+        "Added pull request #%d to project '%s' under column '%s'"
+        % (pull_request.number, project.name, column.name)
+    )
+
+
+def create_or_update_pull_request(
+    github_token,
+    github_repository,
+    branch,
+    base,
+    title,
+    body,
+    labels,
+    assignees,
+    milestone,
+    reviewers,
+    team_reviewers,
+    project_name,
+    project_column_name,
+    draft,
+    request_to_parent,
+):
+    github_repo = head_repo = Github(github_token).get_repo(github_repository)
+    if string_to_bool(request_to_parent):
+        github_repo = github_repo.parent
+        if github_repo is None:
+            raise ValueError(
+                "The checked out repository is not a fork. Input 'request-to-parent' should be set to false."
+            )
+
+    head_branch = f"{head_repo.owner.login}:{branch}"
+
+    # Create the pull request
+    try:
+        pull_request = github_repo.create_pull(
+            title=title,
+            body=body,
+            base=base,
+            head=head_branch,
+            draft=string_to_bool(draft),
+        )
+        print(
+            f"Created pull request #{pull_request.number} ({head_branch} => {github_repo.owner.login}:{base})"
+        )
+    except GithubException as e:
+        if e.status == 422:
+            # A pull request exists for this branch and base
+            # Get the pull request
+            pull_request = github_repo.get_pulls(
+                state="open", base=base, head=head_branch
+            )[0]
+            # Update title and body
+            pull_request.as_issue().edit(title=title, body=body)
+            print(
+                f"Updated pull request #{pull_request.number} ({head_branch} => {github_repo.owner.login}:{base})"
+            )
+        else:
+            print(str(e))
+            raise
+
+    # Set the output variables
+    os.system(f"echo ::set-env name=PULL_REQUEST_NUMBER::{pull_request.number}")
+    os.system(f"echo ::set-output name=pull-request-number::{pull_request.number}")
+    # 'pr_number' is deprecated
+    os.system(f"echo ::set-output name=pr_number::{pull_request.number}")
+
+    # Set labels, assignees and milestone
+    if labels is not None:
+        print(f"Applying labels '{labels}'")
+        pull_request.as_issue().edit(labels=cs_string_to_list(labels))
+    if assignees is not None:
+        print(f"Applying assignees '{assignees}'")
+        pull_request.as_issue().edit(assignees=cs_string_to_list(assignees))
+    if milestone is not None:
+        print(f"Applying milestone '{milestone}'")
+        milestone = github_repo.get_milestone(int(milestone))
+        pull_request.as_issue().edit(milestone=milestone)
+
+    # Set pull request reviewers
+    if reviewers is not None:
+        print(f"Requesting reviewers '{reviewers}'")
+        try:
+            pull_request.create_review_request(reviewers=cs_string_to_list(reviewers))
+        except GithubException as e:
+            # Likely caused by "Review cannot be requested from pull request author."
+            if e.status == 422:
+                print("Request reviewers failed - {}".format(e.data["message"]))
+
+    # Set pull request team reviewers
+    if team_reviewers is not None:
+        print(f"Requesting team reviewers '{team_reviewers}'")
+        pull_request.create_review_request(
+            team_reviewers=cs_string_to_list(team_reviewers)
+        )
+
+    # Create a project card for the pull request
+    if project_name is not None and project_column_name is not None:
+        try:
+            create_project_card(
+                github_repo, project_name, project_column_name, pull_request
+            )
+        except GithubException as e:
+            # Likely caused by "Project already has the associated issue."
+            if e.status == 422:
+                print(
+                    "Create project card failed - {}".format(
+                        e.data["errors"][0]["message"]
+                    )
+                )

dist/cpr/create_pull_request.py

@@ -0,0 +1,229 @@
+#!/usr/bin/env python3
+""" Create Pull Request """
+import base64
+import common as cmn
+import create_or_update_branch as coub
+import create_or_update_pull_request as coupr
+from git import Repo, GitCommandError
+import json
+import os
+import sys
+import time
+
+
+# Default the committer and author to the GitHub Actions bot
+DEFAULT_COMMITTER = "GitHub <noreply@github.com>"
+DEFAULT_AUTHOR = (
+    "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+)
+DEFAULT_COMMIT_MESSAGE = "[create-pull-request] automated change"
+DEFAULT_TITLE = "Changes by create-pull-request action"
+DEFAULT_BODY = (
+    "Automated changes by "
+    + "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action"
+)
+DEFAULT_BRANCH = "create-pull-request/patch"
+
+
+def get_git_config_value(repo, name):
+    try:
+        return repo.git.config("--get", name)
+    except GitCommandError:
+        return None
+
+
+def get_repository_detail(repo):
+    remote_origin_url = get_git_config_value(repo, "remote.origin.url")
+    if remote_origin_url is None:
+        raise ValueError("Failed to fetch 'remote.origin.url' from git config")
+    protocol, github_repository = cmn.parse_github_repository(remote_origin_url)
+    return remote_origin_url, protocol, github_repository
+
+
+def git_user_config_is_set(repo):
+    name = get_git_config_value(repo, "user.name")
+    email = get_git_config_value(repo, "user.email")
+
+    if name is not None and email is not None:
+        print(f"Git user already configured as '{name} <{email}>'")
+        return True
+
+    committer_name = get_git_config_value(repo, "committer.name")
+    committer_email = get_git_config_value(repo, "committer.email")
+    author_name = get_git_config_value(repo, "author.name")
+    author_email = get_git_config_value(repo, "author.email")
+
+    if (
+        committer_name is not None
+        and committer_email is not None
+        and author_name is not None
+        and author_email is not None
+    ):
+        print(
+            f"Git committer already configured as '{committer_name} <{committer_email}>'"
+        )
+        print(f"Git author already configured as '{author_name} <{author_email}>'")
+        return True
+
+    return False
+
+
+def set_committer_author(repo, committer, author):
+    # If either committer or author is supplied they will be cross used
+    if committer is None and author is not None:
+        print("Supplied author will also be used as the committer.")
+        committer = author
+    if author is None and committer is not None:
+        print("Supplied committer will also be used as the author.")
+        author = committer
+
+    # If no committer/author has been supplied but user configuration already
+    # exists in git config we can exit and use the existing config as-is.
+    if committer is None and author is None:
+        if git_user_config_is_set(repo):
+            return
+
+    # Set defaults if no committer/author has been supplied
+    if committer is None and author is None:
+        committer = DEFAULT_COMMITTER
+        author = DEFAULT_AUTHOR
+
+    # Set git environment. This will not persist after the action completes.
+    committer_name, committer_email = cmn.parse_display_name_email(committer)
+    author_name, author_email = cmn.parse_display_name_email(author)
+    repo.git.update_environment(
+        GIT_COMMITTER_NAME=committer_name,
+        GIT_COMMITTER_EMAIL=committer_email,
+        GIT_AUTHOR_NAME=author_name,
+        GIT_AUTHOR_EMAIL=author_email,
+    )
+    print(f"Configured git committer as '{committer_name} <{committer_email}>'")
+    print(f"Configured git author as '{author_name} <{author_email}>'")
+
+
+# Get required environment variables
+github_token = os.environ["GITHUB_TOKEN"]
+# Get environment variables with defaults
+path = os.getenv("CPR_PATH", os.getcwd())
+branch = os.getenv("CPR_BRANCH", DEFAULT_BRANCH)
+commit_message = os.getenv("CPR_COMMIT_MESSAGE", DEFAULT_COMMIT_MESSAGE)
+# Get environment variables with a default of 'None'
+committer = os.environ.get("CPR_COMMITTER")
+author = os.environ.get("CPR_AUTHOR")
+base = os.environ.get("CPR_BASE")
+
+# Set the repo path
+repo = Repo(path)
+
+# Determine the GitHub repository from git config
+# This will be the target repository for the pull request
+repo_url, protocol, github_repository = get_repository_detail(repo)
+print(f"Target repository set to {github_repository}")
+
+if protocol == "HTTPS":
+    print(f"::debug::Using HTTPS protocol")
+    # Encode and configure the basic credential for HTTPS access
+    basic_credential = base64.b64encode(
+        f"x-access-token:{github_token}".encode("utf-8")
+    ).decode("utf-8")
+    # Mask the basic credential in logs and debug output
+    print(f"::add-mask::{basic_credential}")
+    repo.git.set_persistent_git_options(
+        c=f"http.https://github.com/.extraheader=AUTHORIZATION: basic {basic_credential}"
+    )
+
+# 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
+try:
+    working_base = repo.git.symbolic_ref("HEAD", "--short")
+except GitCommandError as e:
+    print(f"::debug::{e.stderr}")
+    print(
+        f"::error::The checked out ref is not a valid base for a pull request. "
+        + "Unable to continue. Exiting."
+    )
+    sys.exit(1)
+
+# Exit if the working base is a PR branch created by this action.
+# This may occur when using a PAT instead of GITHUB_TOKEN because
+# a PAT allows workflow actions to trigger further events.
+if working_base.startswith(branch):
+    print(
+        f"::error::Working base branch '{working_base}' was created by this action. "
+        + "Unable to continue. Exiting."
+    )
+    sys.exit(1)
+
+# Fetch an optional environment variable to determine the branch suffix
+branch_suffix = os.environ.get("CPR_BRANCH_SUFFIX")
+if branch_suffix is not None:
+    if branch_suffix == "short-commit-hash":
+        # Suffix with the short SHA1 hash
+        branch = "{}-{}".format(branch, repo.git.rev_parse("--short", "HEAD"))
+    elif branch_suffix == "timestamp":
+        # Suffix with the current timestamp
+        branch = "{}-{}".format(branch, int(time.time()))
+    elif branch_suffix == "random":
+        # Suffix with a 7 character random string
+        branch = "{}-{}".format(branch, cmn.get_random_string())
+    else:
+        print(
+            f"::error::Branch suffix '{branch_suffix}' is not a valid value. "
+            + "Unable to continue. Exiting."
+        )
+        sys.exit(1)
+
+# Output head branch
+print(f"Pull request branch to create or update set to '{branch}'")
+
+# Set the committer and author
+try:
+    set_committer_author(repo, committer, author)
+except ValueError as e:
+    print(f"::error::{e} " + "Unable to continue. Exiting.")
+    sys.exit(1)
+
+# Create or update the pull request branch
+result = coub.create_or_update_branch(repo, repo_url, commit_message, base, branch)
+
+if result["action"] in ["created", "updated"]:
+    # The branch was created or updated
+    print(f"Pushing pull request branch to 'origin/{branch}'")
+    repo.git.push("--force", repo_url, f"HEAD:refs/heads/{branch}")
+
+    # Set the base. It would have been 'None' if not specified as an input
+    base = result["base"]
+
+    # If there is no longer a diff with the base delete the branch and exit
+    if not result["diff"]:
+        print(f"Branch '{branch}' no longer differs from base branch '{base}'")
+        print(f"Closing pull request and deleting branch '{branch}'")
+        repo.git.push("--delete", "--force", repo_url, f"refs/heads/{branch}")
+        sys.exit()
+
+    # Fetch optional environment variables with default values
+    title = os.getenv("CPR_TITLE", DEFAULT_TITLE)
+    body = os.getenv("CPR_BODY", DEFAULT_BODY)
+
+    # Create or update the pull request
+    coupr.create_or_update_pull_request(
+        github_token,
+        github_repository,
+        branch,
+        base,
+        title,
+        body,
+        os.environ.get("CPR_LABELS"),
+        os.environ.get("CPR_ASSIGNEES"),
+        os.environ.get("CPR_MILESTONE"),
+        os.environ.get("CPR_REVIEWERS"),
+        os.environ.get("CPR_TEAM_REVIEWERS"),
+        os.environ.get("CPR_PROJECT_NAME"),
+        os.environ.get("CPR_PROJECT_COLUMN_NAME"),
+        os.environ.get("CPR_DRAFT"),
+        os.environ.get("CPR_REQUEST_TO_PARENT"),
+    )

dist/cpr/requirements.txt

@@ -0,0 +1,4 @@
+setuptools==46.4.0
+wheel==0.34.2
+GitPython==3.1.2
+PyGithub==1.51

dist/cpr/test_common.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python3
+""" Test Common """
+import common as cmn
+import pytest
+
+
+def test_get_random_string():
+    assert len(cmn.get_random_string()) == 7
+    assert len(cmn.get_random_string(length=20)) == 20
+
+
+def test_parse_github_repository_success():
+    protocol, repository = cmn.parse_github_repository(
+        "https://github.com/peter-evans/create-pull-request"
+    )
+    assert protocol == "HTTPS"
+    assert repository == "peter-evans/create-pull-request"
+
+    protocol, repository = cmn.parse_github_repository(
+        "https://xxx:x-oauth-basic@github.com/peter-evans/create-pull-request"
+    )
+    assert protocol == "HTTPS"
+    assert repository == "peter-evans/create-pull-request"
+
+    protocol, repository = cmn.parse_github_repository(
+        "git@github.com:peter-evans/create-pull-request.git"
+    )
+    assert protocol == "SSH"
+    assert repository == "peter-evans/create-pull-request"
+
+
+def test_parse_github_repository_failure():
+    url = "https://github.com/peter-evans"
+    with pytest.raises(ValueError) as e_info:
+        cmn.parse_github_repository(url)
+    assert (
+        e_info.value.args[0]
+        == f"The format of '{url}' is not a valid GitHub repository URL"
+    )
+
+
+def test_parse_display_name_email_success():
+    name, email = cmn.parse_display_name_email("abc def <abc@def.com>")
+    assert name == "abc def"
+    assert email == "abc@def.com"
+
+    name, email = cmn.parse_display_name_email(
+        "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+    )
+    assert name == "github-actions[bot]"
+    assert email == "41898282+github-actions[bot]@users.noreply.github.com"
+
+
+def test_parse_display_name_email_failure():
+    display_name_email = "abc@def.com"
+    with pytest.raises(ValueError) as e_info:
+        cmn.parse_display_name_email(display_name_email)
+    assert (
+        e_info.value.args[0]
+        == f"The format of '{display_name_email}' is not a valid email address with display name"
+    )
+
+    display_name_email = " < >"
+    with pytest.raises(ValueError) as e_info:
+        cmn.parse_display_name_email(display_name_email)
+    assert (
+        e_info.value.args[0]
+        == f"The format of '{display_name_email}' is not a valid email address with display name"
+    )

dist/cpr/test_create_or_update_branch.py

@@ -0,0 +1,757 @@
+#!/usr/bin/env python3
+""" Test Create or Update Branch """
+import create_or_update_branch as coub
+from git import Repo
+import os
+import pytest
+import sys
+import time
+
+
+# Set git repo
+REPO_PATH = os.getenv("COUB_REPO_PATH", os.getcwd())
+repo = Repo(REPO_PATH)
+
+# Set git environment
+author_name = "github-actions[bot]"
+author_email = "41898282+github-actions[bot]@users.noreply.github.com"
+committer_name = "GitHub"
+committer_email = "noreply@github.com"
+repo.git.update_environment(
+    GIT_AUTHOR_NAME=author_name,
+    GIT_AUTHOR_EMAIL=author_email,
+    GIT_COMMITTER_NAME=committer_name,
+    GIT_COMMITTER_EMAIL=committer_email,
+)
+
+REPO_URL = repo.git.config("--get", "remote.origin.url")
+
+TRACKED_FILE = "tracked-file.txt"
+UNTRACKED_FILE = "untracked-file.txt"
+
+DEFAULT_BRANCH = "tests/master"
+NOT_BASE_BRANCH = "tests/branch-that-is-not-the-base"
+NOT_EXIST_BRANCH = "tests/branch-that-does-not-exist"
+
+COMMIT_MESSAGE = "[create-pull-request] automated change"
+BRANCH = "tests/create-pull-request/patch"
+BASE = DEFAULT_BRANCH
+
+
+def create_tracked_change(content=None):
+    if content is None:
+        content = str(time.time())
+    # Create a tracked file change
+    with open(os.path.join(REPO_PATH, TRACKED_FILE), "w") as f:
+        f.write(content)
+    return content
+
+
+def create_untracked_change(content=None):
+    if content is None:
+        content = str(time.time())
+    # Create an untracked file change
+    with open(os.path.join(REPO_PATH, UNTRACKED_FILE), "w") as f:
+        f.write(content)
+    return content
+
+
+def get_tracked_content():
+    # Read the content of the tracked file
+    with open(os.path.join(REPO_PATH, TRACKED_FILE), "r") as f:
+        return f.read()
+
+
+def get_untracked_content():
+    # Read the content of the untracked file
+    with open(os.path.join(REPO_PATH, UNTRACKED_FILE), "r") as f:
+        return f.read()
+
+
+def create_changes(tracked_content=None, untracked_content=None):
+    tracked_content = create_tracked_change(tracked_content)
+    untracked_content = create_untracked_change(untracked_content)
+    return tracked_content, untracked_content
+
+
+def create_commits(number=2, final_tracked_content=None, final_untracked_content=None):
+    for i in range(number):
+        commit_number = i + 1
+        if commit_number == number:
+            tracked_content, untracked_content = create_changes(
+                final_tracked_content, final_untracked_content
+            )
+        else:
+            tracked_content, untracked_content = create_changes()
+        repo.git.add("-A")
+        repo.git.commit(m=f"Commit {commit_number}")
+    return tracked_content, untracked_content
+
+
+@pytest.fixture(scope="module", autouse=True)
+def before_after_all():
+    print("Before all tests")
+    # Check there are no local changes that might be
+    # destroyed by running these tests
+    assert not repo.is_dirty(untracked_files=True)
+
+    # Create a new default branch for the test run
+    repo.remotes.origin.fetch()
+    repo.git.checkout("master")
+    repo.git.checkout("HEAD", b=NOT_BASE_BRANCH)
+    create_tracked_change()
+    repo.git.add("-A")
+    repo.git.commit(m="This commit should not appear in pr branches")
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{NOT_BASE_BRANCH}")
+    # Create a new default branch for the test run
+    repo.git.checkout("master")
+    repo.git.checkout("HEAD", b=DEFAULT_BRANCH)
+    create_tracked_change()
+    repo.git.add("-A")
+    repo.git.commit(m="Add file to be a tracked file for tests")
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+
+    yield
+
+    print("After all tests")
+    repo.git.checkout("master")
+    # Delete the "not base branch" created for the test run
+    repo.git.branch("--delete", "--force", NOT_BASE_BRANCH)
+    repo.git.push("--delete", "--force", REPO_URL, f"refs/heads/{NOT_BASE_BRANCH}")
+    # Delete the default branch created for the test run
+    repo.git.branch("--delete", "--force", DEFAULT_BRANCH)
+    repo.git.push("--delete", "--force", REPO_URL, f"refs/heads/{DEFAULT_BRANCH}")
+
+
+def before_test():
+    print("Before test")
+    # Checkout the default branch
+    repo.git.checkout(DEFAULT_BRANCH)
+
+
+def after_test(delete_remote=True):
+    print("After test")
+    # Output git log
+    print(repo.git.log("-5", pretty="oneline"))
+    # Delete the pull request branch if it exists
+    repo.git.checkout(DEFAULT_BRANCH)
+    print(f"Deleting {BRANCH}")
+    for branch in repo.branches:
+        if branch.name == BRANCH:
+            repo.git.branch("--delete", "--force", BRANCH)
+            break
+    if delete_remote:
+        print(f"Deleting origin/{BRANCH}")
+        for ref in repo.remotes.origin.refs:
+            if ref.name == f"origin/{BRANCH}":
+                repo.git.push("--delete", "--force", REPO_URL, f"refs/heads/{BRANCH}")
+                repo.remotes.origin.fetch("--prune")
+                break
+
+
+@pytest.fixture(autouse=True)
+def before_after_tests():
+    before_test()
+    yield
+    after_test()
+
+
+# Tests if a branch exists and can be fetched
+def coub_fetch_successful():
+    assert coub.fetch_successful(repo, REPO_URL, NOT_BASE_BRANCH)
+    assert not coub.fetch_successful(repo, REPO_URL, NOT_EXIST_BRANCH)
+
+
+# Tests no changes resulting in no new branch being created
+def coub_no_changes_on_create():
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "none"
+
+
+# Tests create and update with a tracked file change
+def coub_tracked_changes():
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+
+
+# Tests create and update with an untracked file change
+def coub_untracked_changes():
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with identical changes
+# The pull request branch will not be updated
+def coub_identical_changes():
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create identical tracked and untracked file changes
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "none"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with commits on the base inbetween
+def coub_commits_on_base():
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and then an update with no changes
+# This effectively reverts the branch back to match the base and results in no diff
+def coub_changes_no_diff():
+    # Save the default branch tracked content
+    default_tracked_content = get_tracked_content()
+
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Running with no update effectively reverts the branch back to match the base
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == default_tracked_content
+
+
+# Tests create and update with commits on the base inbetween
+# The changes on base effectively revert the branch back to match the base and results in no diff
+def coub_commits_on_base_no_diff():
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    tracked_content, untracked_content = create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Create the same tracked and untracked file changes that were made to the base
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with commits on the working base (during the workflow)
+def coub_commits_on_working_base():
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with changes and commits on the working base (during the workflow)
+def coub_changes_and_commits_on_working_base():
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with changes and commits on the working base (during the workflow)
+# with commits on the base inbetween
+def coub_changes_and_commits_on_base_and_working_base():
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests no changes resulting in no new branch being created
+def coub_wbnb_no_changes_on_create():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "none"
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with a tracked file change
+def coub_wbnb_tracked_changes():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with an untracked file change
+def coub_wbnb_untracked_changes():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with identical changes
+# The pull request branch will not be updated
+def coub_wbnb_identical_changes():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create identical tracked and untracked file changes
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "none"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with commits on the base inbetween
+def coub_wbnb_commits_on_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and then an update with no changes
+# This effectively reverts the branch back to match the base and results in no diff
+def coub_wbnb_changes_no_diff():
+    # Save the default branch tracked content
+    default_tracked_content = get_tracked_content()
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Running with no update effectively reverts the branch back to match the base
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == default_tracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with commits on the base inbetween
+# The changes on base effectively revert the branch back to match the base and results in no diff
+# This scenario will cause cherrypick to fail due to an empty commit.
+# The commit is empty because the changes now exist on the base.
+def coub_wbnb_commits_on_base_no_diff():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    tracked_content, untracked_content = create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create the same tracked and untracked file changes that were made to the base
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with commits on the working base (during the workflow)
+def coub_wbnb_commits_on_working_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with changes and commits on the working base (during the workflow)
+def coub_wbnb_changes_and_commits_on_working_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with changes and commits on the working base (during the workflow)
+# with commits on the base inbetween
+def coub_wbnb_changes_and_commits_on_base_and_working_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# pytest -v -s ~/git/create-pull-request/src
+
+test_coub_fetch_successful = coub_fetch_successful
+
+test_coub_no_changes_on_create = coub_no_changes_on_create
+test_coub_tracked_changes = coub_tracked_changes
+test_coub_untracked_changes = coub_untracked_changes
+test_coub_identical_changes = coub_identical_changes
+test_coub_commits_on_base = coub_commits_on_base
+
+test_coub_changes_no_diff = coub_changes_no_diff
+test_coub_commits_on_base_no_diff = coub_commits_on_base_no_diff
+
+test_coub_commits_on_working_base = coub_commits_on_working_base
+test_coub_changes_and_commits_on_working_base = coub_changes_and_commits_on_working_base
+test_coub_changes_and_commits_on_base_and_working_base = (
+    coub_changes_and_commits_on_base_and_working_base
+)
+
+# WBNB
+test_coub_wbnb_no_changes_on_create = coub_wbnb_no_changes_on_create
+test_coub_wbnb_tracked_changes = coub_wbnb_tracked_changes
+test_coub_wbnb_untracked_changes = coub_wbnb_untracked_changes
+test_coub_wbnb_identical_changes = coub_wbnb_identical_changes
+test_coub_wbnb_commits_on_base = coub_wbnb_commits_on_base
+
+test_coub_wbnb_changes_no_diff = coub_wbnb_changes_no_diff
+test_coub_wbnb_commits_on_base_no_diff = coub_wbnb_commits_on_base_no_diff
+
+test_coub_wbnb_commits_on_working_base = coub_wbnb_commits_on_working_base
+test_coub_wbnb_changes_and_commits_on_working_base = (
+    coub_wbnb_changes_and_commits_on_working_base
+)
+test_coub_wbnb_changes_and_commits_on_base_and_working_base = (
+    coub_wbnb_changes_and_commits_on_base_and_working_base
+)

docs/assets/cpr-gitgraph.htm

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

docs/concepts-guidelines.md

@@ -0,0 +1,337 @@
+# Concepts, guidelines and advanced usage
+
+This document covers terminology, how the action works, general usage guidelines, and advanced usage.
+
+- [Terminology](#terminology)
+- [Events and checkout](#events-and-checkout)
+- [How the action works](#how-the-action-works)
+- [Guidelines](#guidelines)
+  - [Providing a consistent base](#providing-a-consistent-base)
+  - [Pull request events](#pull-request-events)
+  - [Restrictions on forked repositories](#restrictions-on-forked-repositories)
+  - [Triggering further workflow runs](#triggering-further-workflow-runs)
+  - [Security](#security)
+- [Advanced usage](#advanced-usage)
+  - [Creating pull requests in a remote repository](#creating-pull-requests-in-a-remote-repository)
+  - [Push using SSH (deploy keys)](#push-using-ssh-deploy-keys)
+  - [Push pull request branches to a fork](#push-pull-request-branches-to-a-fork)
+  - [Running in a container](#running-in-a-container)
+  - [Creating pull requests on tag push](#creating-pull-requests-on-tag-push)
+
+## Terminology
+
+[Pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#about-pull-requests) are proposed changes to a repository branch that can be reviewed by a repository's collaborators before being accepted or rejected. 
+
+A pull request references two branches:
+
+- The `base` of a pull request is the branch you intend to change once the proposed changes are merged.
+- The `branch` of a pull request represents what you intend the `base` to look like when merged. It is the `base` branch *plus* changes that have been made to it.
+
+## Events and checkout
+
+For each [event type](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/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`.
+
+The default can be overridden by specifying a `ref` on checkout.
+
+```yml
+      - uses: actions/checkout@v2
+        with:
+          ref: develop
+```
+
+## How the action works
+
+By default, the action expects to be executed on the pull request `base`—the branch you intend to modify with the proposed changes.
+
+Workflow steps:
+
+1. Checkout the `base` branch
+2. Make changes
+3. Execute `create-pull-request` action
+
+The following git diagram shows how the action creates and updates a pull request branch.
+
+![Create Pull Request GitGraph](assets/cpr-gitgraph.png)
+
+## Guidelines
+
+### Providing a consistent base
+
+For the action to work correctly it should be executed in a workflow that checks out a *consistent base* branch. This will be the base of the pull request unless overridden with the `base` input.
+
+This means your workflow should be consistently checking out the branch that you intend to modify once the PR is merged.
+
+In the following example, the [`push`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#push-event-push) and [`create`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#create-event-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.
+
+```yml
+on:
+  push:
+  create:
+jobs:
+  example:
+    runs-on: ubuntu-latest
+    steps:
+      - 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.
+
+### Pull request events
+
+Workflows triggered by `pull_request` events will by default check out a [merge commit](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-event-pull_request). To prevent the merge commit being included in created pull requests it is necessary to checkout the `head_ref`.
+
+```yml
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+```
+
+### Restrictions on forked repositories
+
+GitHub Actions have imposed restrictions on events triggered by a forked repository. Specifically, the `pull_request` event triggered by a fork opening a pull request in the upstream repository.
+
+- Events from forks cannot access secrets, except for for the default `GITHUB_TOKEN`.
+    > With the exception of GITHUB_TOKEN, secrets are not passed to the runner when a workflow is triggered from a forked repository.
+
+    [GitHub Actions: Using encrypted secrets in a workflow](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#using-encrypted-secrets-in-a-workflow)
+
+- The `GITHUB_TOKEN` has read-only access when an event is triggered by a forked repository.
+
+   [GitHub Actions: Permissions for the GITHUB_TOKEN](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#permissions-for-the-github_token)
+
+These restrictions mean that during a `pull_request` event triggered by a forked repository, actions have no write access to GitHub resources and will fail on attempt.
+
+A job condition can be added to prevent workflows from executing when triggered by a repository fork.
+
+```yml
+on: pull_request
+jobs:
+  example:
+    runs-on: ubuntu-latest
+    # Check if the event is not triggered by a fork
+    if: github.event.pull_request.head.repo.full_name == github.repository
+```
+
+### Triggering further workflow runs
+
+Pull requests created by the action using the default `GITHUB_TOKEN` cannot trigger other workflows. If you have `on: pull_request` or `on: push` workflows acting as checks on pull requests, they will not run.
+
+> When you use the repository's GITHUB_TOKEN to perform tasks on behalf of the GitHub Actions app, events triggered by the GITHUB_TOKEN will not create a new workflow run.
+
+[GitHub Actions: Events that trigger workflows](https://help.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token)
+
+#### Workarounds to trigger further workflow runs
+
+There are a number of workarounds with different pros and cons.
+
+- Use the default `GITHUB_TOKEN` and allow the action to create pull requests that have no checks enabled. Manually close pull requests and immediately reopen them. This will enable `on: pull_request` workflows to run and be added as checks.
+- Use a `repo` scoped [Personal Access Token (PAT)](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) 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://help.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://help.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.
+
+### Security
+
+From a security perspective it's good practice to fork third-party actions, review the code, and use your fork of the action in workflows.
+By using third-party actions directly the risk exists that it could be modified to do something malicious, such as capturing secrets.
+
+This action uses [ncc](https://github.com/zeit/ncc) to compile the Node.js code and dependencies into a single file.
+Python dependencies are vendored and committed to the repository [here](https://github.com/peter-evans/create-pull-request/tree/master/dist/vendor).
+No dependencies are downloaded during the action execution.
+
+Vendored Python dependencies can be reviewed by rebuilding the [dist](https://github.com/peter-evans/create-pull-request/tree/master/dist) directory and redownloading dependencies.
+The following commands require Node and Python 3.
+
+```
+npm install
+npm run clean
+npm run package
+```
+
+The `dist` directory should be rebuilt leaving no git diff.
+
+## Advanced usage
+
+### Creating pull requests in a remote repository
+
+Checking out a branch from a different repository from where the workflow is executing will make *that repository* the target for the created pull request. In this case, a `repo` scoped [Personal Access Token (PAT)](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) is required.
+
+```yml
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.PAT }}
+          repository: owner/repo
+
+      # Make changes to pull request here
+
+      - uses: peter-evans/create-pull-request@v2
+        with:
+          token: ${{ secrets.PAT }}
+```
+
+### Push using SSH (deploy keys)
+
+[Deploy keys](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) can be set per repository and so are arguably more secure than using a `repo` scoped [Personal Access Token (PAT)](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
+Allowing the action to push with a configured deploy key will trigger `on: push` workflows. This makes it an alternative to using a PAT to trigger checks for pull requests.
+
+How to use SSH (deploy keys) with create-pull-request action:
+
+1. [Create a new SSH key pair](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key) for your repository. Do not set a passphrase.
+2. Copy the contents of the public key (.pub file) to a new repository [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) and check the box to "Allow write access."
+3. Add a secret to the repository containing the entire contents of the private key.
+4. As shown in the example below, configure `actions/checkout` to use the deploy key you have created.
+
+```yml
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+```
+
+### Push pull request branches to a fork
+
+Instead of pushing pull request branches to the repository you want to update, you can push them to a fork of that repository.
+This allows you to employ the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege) by using a dedicated user acting as a [machine account](https://help.github.com/en/github/site-policy/github-terms-of-service#3-account-requirements).
+This user has no access to the main repository.
+It will use their own fork to push code and create the pull request.
+
+1. Create a new GitHub user and login.
+2. Fork the repository that you will be creating pull requests in.
+3. Create a [Personal Access Token (PAT)](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
+4. Logout and log back in to your main user account.
+5. Add a secret to your repository containing the above PAT.
+6. As shown in the following example workflow, switch the git remote to the fork's URL after checkout and set the action input `request-to-parent` to `true`.
+
+```yaml
+      - uses: actions/checkout@v2
+
+      - run: |
+          git config user.password ${{ secrets.MACHINE_USER_PAT }}
+          git remote set-url origin https://github.com/machine-user/fork-of-repository
+          git fetch --unshallow -p origin
+
+      # Make changes to pull request here
+
+      - uses: peter-evans/create-pull-request@v2
+        with:
+          token: ${{ secrets.MACHINE_USER_PAT }}
+          request-to-parent: true
+```
+
+### Running in a container
+
+This action can be run inside a container by installing the action's dependencies either in the Docker image itself, or during the workflow.
+
+The action requires `python3`, `pip3` and `git` to be installed and on the `PATH`.
+
+Note that `actions/checkout` requires Git 2.18 or higher to be installed, otherwise it will just download the source of the repository instead of cloning it.
+
+**Alpine container example:**
+```yml
+jobs:
+  createPullRequestAlpine:
+    runs-on: ubuntu-latest
+    container:
+      image: alpine
+    steps:
+      - name: Install dependencies
+        run: |
+          apk --no-cache add git python3
+          python3 -m ensurepip
+
+      - uses: actions/checkout@v2
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+```
+
+**Ubuntu container example:**
+```yml
+jobs:
+  createPullRequestAlpine:
+    runs-on: ubuntu-latest
+    container:
+      image: ubuntu
+    steps:
+      - name: Install dependencies
+        run: |
+          apt-get update
+          apt-get install -y software-properties-common
+          add-apt-repository -y ppa:git-core/ppa
+          apt-get install -y python3 python3-pip git
+
+      - uses: actions/checkout@v2
+
+      # Make changes to pull request here
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+```
+
+### 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@v2
+        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@v2
+```

docs/examples.md

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

docs/updating.md

@@ -0,0 +1,25 @@
+# Updating from `v1` to `v2`
+
+## Breaking changes
+
+- `v2` now expects repositories to be checked out with `actions/checkout@v2`
+
+  To use `actions/checkout@v1` the following step to checkout the branch is necessary.
+  ```
+      - uses: actions/checkout@v1
+      - name: Checkout branch
+        run: git checkout "${GITHUB_REF:11}"
+  ```
+
+- The two branch naming strategies have been swapped. Fixed branch naming strategy is now the default. i.e. `branch-suffix: none` is now the default and should be removed from configuration if set.
+
+- `author-name`, `author-email`, `committer-name`, `committer-email` have been removed in favour of `author` and `committer`.
+  They can both be set in the format `Display Name <email@address.com>`
+
+  If neither `author` or `committer` are set the action will default to making commits as the GitHub Actions bot user.
+
+## 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.
+- 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.

jest.config.js

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

package.json

@@ -0,0 +1,56 @@
+{
+  "name": "create-pull-request",
+  "version": "2.0.0",
+  "private": true,
+  "description": "Creates a pull request for changes to your repository in the actions workspace",
+  "main": "lib/main.js",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc && ncc build",
+    "format": "prettier --write '**/*.ts'",
+    "format-check": "prettier --check '**/*.ts'",
+    "lint": "eslint src/**/*.ts",
+    "test:unit": "jest unit",
+    "test:int": "__test__/integration-tests.sh",
+    "test": "npm run test:unit && npm run test:int",
+    "pack-assets": "mkdir -p dist/cpr && cp -rv src/cpr/* dist/cpr",
+    "vendor-deps": "pip download -r src/cpr/requirements.txt --no-binary=:all: -d dist/vendor",
+    "package": "npm run build && npm run pack-assets && npm run vendor-deps"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peter-evans/create-pull-request.git"
+  },
+  "keywords": [
+    "actions",
+    "pull",
+    "request"
+  ],
+  "author": "Peter Evans",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/peter-evans/create-pull-request/issues"
+  },
+  "homepage": "https://github.com/peter-evans/create-pull-request",
+  "dependencies": {
+    "@actions/core": "1.2.4",
+    "@actions/exec": "1.0.4",
+    "@actions/tool-cache": "1.3.4",
+    "is-docker": "2.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "25.2.2",
+    "@types/node": "14.0.1",
+    "@typescript-eslint/parser": "2.33.0",
+    "@zeit/ncc": "0.22.1",
+    "eslint": "7.0.0",
+    "eslint-plugin-github": "3.4.1",
+    "eslint-plugin-jest": "23.11.0",
+    "jest": "26.0.1",
+    "jest-circus": "26.0.1",
+    "js-yaml": "3.13.1",
+    "prettier": "2.0.5",
+    "ts-jest": "25.5.1",
+    "typescript": "3.9.2"
+  }
+}

renovate.json

@@ -1,5 +1,9 @@
 {
   "extends": [
     "config:base"
+  ],
+  "enabledManagers": ["pip_requirements"],
+  "ignorePaths": [
+    "**/dist/**"
   ]
 }

requirements.txt

@@ -1,2 +0,0 @@
-GitPython==3.0.2
-PyGithub==1.43.8

src/cpr/common.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+import random
+import re
+import string
+
+
+def get_random_string(length=7, chars=string.ascii_lowercase + string.digits):
+    return "".join(random.choice(chars) for _ in range(length))
+
+
+def parse_github_repository(url):
+    # Parse the protocol and github repository from a URL
+    # e.g. HTTPS, peter-evans/create-pull-request
+    https_pattern = re.compile(r"^https://.*@?github.com/(.+/.+)$")
+    ssh_pattern = re.compile(r"^git@github.com:(.+/.+).git$")
+
+    match = https_pattern.match(url)
+    if match is not None:
+        return "HTTPS", match.group(1)
+
+    match = ssh_pattern.match(url)
+    if match is not None:
+        return "SSH", match.group(1)
+
+    raise ValueError(f"The format of '{url}' is not a valid GitHub repository URL")
+
+
+def parse_display_name_email(display_name_email):
+    # Parse the name and email address from a string in the following format
+    # Display Name <email@address.com>
+    pattern = re.compile(r"^([^<]+)\s*<([^>]+)>$")
+
+    # Check we have a match
+    match = pattern.match(display_name_email)
+    if match is None:
+        raise ValueError(
+            f"The format of '{display_name_email}' is not a valid email address with display name"
+        )
+
+    # Check that name and email are not just whitespace
+    name = match.group(1).strip()
+    email = match.group(2).strip()
+    if len(name) == 0 or len(email) == 0:
+        raise ValueError(
+            f"The format of '{display_name_email}' is not a valid email address with display name"
+        )
+
+    return name, email

src/cpr/create_or_update_branch.py

@@ -0,0 +1,145 @@
+#!/usr/bin/env python3
+""" Create or Update Branch """
+import common as cmn
+from git import Repo, GitCommandError
+import os
+
+
+CHERRYPICK_EMPTY = (
+    "The previous cherry-pick is now empty, possibly due to conflict resolution."
+)
+
+
+def fetch_successful(repo, repo_url, branch):
+    try:
+        repo.git.fetch(repo_url, f"{branch}:refs/remotes/origin/{branch}")
+    except GitCommandError:
+        return False
+    return True
+
+
+def is_ahead(repo, branch_1, branch_2):
+    # Return true if branch_2 is ahead of branch_1
+    return (
+        int(repo.git.rev_list("--right-only", "--count", f"{branch_1}...{branch_2}"))
+        > 0
+    )
+
+
+def is_behind(repo, branch_1, branch_2):
+    # Return true if branch_2 is behind branch_1
+    return (
+        int(repo.git.rev_list("--left-only", "--count", f"{branch_1}...{branch_2}")) > 0
+    )
+
+
+def is_even(repo, branch_1, branch_2):
+    # Return true if branch_2 is even with branch_1
+    return not is_ahead(repo, branch_1, branch_2) and not is_behind(
+        repo, branch_1, branch_2
+    )
+
+
+def has_diff(repo, branch_1, branch_2):
+    diff = repo.git.diff(f"{branch_1}..{branch_2}")
+    return len(diff) > 0
+
+
+def create_or_update_branch(repo, repo_url, commit_message, base, branch):
+    # Set the default return values
+    action = "none"
+    diff = False
+
+    # Get the working base. This may or may not be the actual base.
+    working_base = repo.git.symbolic_ref("HEAD", "--short")
+    # If the base is not specified it is assumed to be the working base
+    if base is None:
+        base = working_base
+
+    # Save the working base changes to a temporary branch
+    temp_branch = cmn.get_random_string(length=20)
+    repo.git.checkout("HEAD", b=temp_branch)
+    # Commit any uncomitted changes
+    if repo.is_dirty(untracked_files=True):
+        print(f"Uncommitted changes found. Adding a commit.")
+        repo.git.add("-A")
+        repo.git.commit(m=commit_message)
+
+    # Perform fetch and reset the working base
+    # Commits made during the workflow will be removed
+    repo.git.fetch("--force", repo_url, f"{working_base}:{working_base}")
+
+    # If the working base is not the base, rebase the temp branch commits
+    if working_base != base:
+        print(
+            f"Rebasing commits made to branch '{working_base}' on to base branch '{base}'"
+        )
+        # Checkout the actual base
+        repo.git.fetch("--force", repo_url, f"{base}:{base}")
+        repo.git.checkout(base)
+        # Cherrypick commits from the temporary branch starting from the working base
+        commits = repo.git.rev_list("--reverse", f"{working_base}..{temp_branch}", ".")
+        for commit in commits.splitlines():
+            try:
+                repo.git.cherry_pick(
+                    "--strategy",
+                    "recursive",
+                    "--strategy-option",
+                    "theirs",
+                    f"{commit}",
+                )
+            except GitCommandError as e:
+                if CHERRYPICK_EMPTY not in e.stderr:
+                    print("Unexpected error: ", e)
+                    raise
+        # Reset the temp branch to the working index
+        repo.git.checkout("-B", temp_branch, "HEAD")
+        # Reset the base
+        repo.git.fetch("--force", repo_url, f"{base}:{base}")
+
+    # Try to fetch the pull request branch
+    if not fetch_successful(repo, repo_url, branch):
+        # The pull request branch does not exist
+        print(f"Pull request branch '{branch}' does not exist yet")
+        # Create the pull request branch
+        repo.git.checkout("HEAD", b=branch)
+        # Check if the pull request branch is ahead of the base
+        diff = is_ahead(repo, base, branch)
+        if diff:
+            action = "created"
+            print(f"Created branch '{branch}'")
+        else:
+            print(
+                f"Branch '{branch}' is not ahead of base '{base}' and will not be created"
+            )
+    else:
+        # The pull request branch exists
+        print(
+            f"Pull request branch '{branch}' already exists as remote branch 'origin/{branch}'"
+        )
+        # Checkout the pull request branch
+        repo.git.checkout(branch)
+
+        if has_diff(repo, branch, temp_branch):
+            # 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
+            print(f"Resetting '{branch}'")
+            repo.git.checkout("-B", branch, temp_branch)
+            # repo.git.switch("-C", branch, temp_branch)
+
+        # Check if the pull request branch has been updated
+        # If the branch was reset or updated it will be ahead
+        # It may be behind if a reset now results in no diff with the base
+        if not is_even(repo, f"origin/{branch}", branch):
+            action = "updated"
+            print(f"Updated branch '{branch}'")
+        else:
+            print(f"Branch '{branch}' is even with its remote and will not be updated")
+
+        # Check if the pull request branch is ahead of the base
+        diff = is_ahead(repo, base, branch)
+
+    # Delete the temporary branch
+    repo.git.branch("--delete", "--force", temp_branch)
+
+    return {"action": action, "diff": diff, "base": base}

src/cpr/create_or_update_pull_request.py

@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+""" Create or Update Pull Request """
+from github import Github, GithubException
+import os
+
+
+def string_to_bool(str):
+    if str is None:
+        return False
+    else:
+        return str.lower() in [
+            "true",
+            "1",
+            "t",
+            "y",
+            "yes",
+            "on",
+        ]
+
+
+def cs_string_to_list(str):
+    # Split the comma separated string into a list
+    l = [i.strip() for i in str.split(",")]
+    # Remove empty strings
+    return list(filter(None, l))
+
+
+def create_project_card(github_repo, project_name, project_column_name, pull_request):
+    # Locate the project by name
+    project = None
+    for project_item in github_repo.get_projects("all"):
+        if project_item.name == project_name:
+            project = project_item
+            break
+
+    if not project:
+        print("::error::Project not found. Unable to create project card.")
+        return
+
+    # Locate the column by name
+    column = None
+    for column_item in project.get_columns():
+        if column_item.name == project_column_name:
+            column = column_item
+            break
+
+    if not column:
+        print("::error::Project column not found. Unable to create project card.")
+        return
+
+    # Create a project card for the pull request
+    column.create_card(content_id=pull_request.id, content_type="PullRequest")
+    print(
+        "Added pull request #%d to project '%s' under column '%s'"
+        % (pull_request.number, project.name, column.name)
+    )
+
+
+def create_or_update_pull_request(
+    github_token,
+    github_repository,
+    branch,
+    base,
+    title,
+    body,
+    labels,
+    assignees,
+    milestone,
+    reviewers,
+    team_reviewers,
+    project_name,
+    project_column_name,
+    draft,
+    request_to_parent,
+):
+    github_repo = head_repo = Github(github_token).get_repo(github_repository)
+    if string_to_bool(request_to_parent):
+        github_repo = github_repo.parent
+        if github_repo is None:
+            raise ValueError(
+                "The checked out repository is not a fork. Input 'request-to-parent' should be set to false."
+            )
+
+    head_branch = f"{head_repo.owner.login}:{branch}"
+
+    # Create the pull request
+    try:
+        pull_request = github_repo.create_pull(
+            title=title,
+            body=body,
+            base=base,
+            head=head_branch,
+            draft=string_to_bool(draft),
+        )
+        print(
+            f"Created pull request #{pull_request.number} ({head_branch} => {github_repo.owner.login}:{base})"
+        )
+    except GithubException as e:
+        if e.status == 422:
+            # A pull request exists for this branch and base
+            # Get the pull request
+            pull_request = github_repo.get_pulls(
+                state="open", base=base, head=head_branch
+            )[0]
+            # Update title and body
+            pull_request.as_issue().edit(title=title, body=body)
+            print(
+                f"Updated pull request #{pull_request.number} ({head_branch} => {github_repo.owner.login}:{base})"
+            )
+        else:
+            print(str(e))
+            raise
+
+    # Set the output variables
+    os.system(f"echo ::set-env name=PULL_REQUEST_NUMBER::{pull_request.number}")
+    os.system(f"echo ::set-output name=pull-request-number::{pull_request.number}")
+    # 'pr_number' is deprecated
+    os.system(f"echo ::set-output name=pr_number::{pull_request.number}")
+
+    # Set labels, assignees and milestone
+    if labels is not None:
+        print(f"Applying labels '{labels}'")
+        pull_request.as_issue().edit(labels=cs_string_to_list(labels))
+    if assignees is not None:
+        print(f"Applying assignees '{assignees}'")
+        pull_request.as_issue().edit(assignees=cs_string_to_list(assignees))
+    if milestone is not None:
+        print(f"Applying milestone '{milestone}'")
+        milestone = github_repo.get_milestone(int(milestone))
+        pull_request.as_issue().edit(milestone=milestone)
+
+    # Set pull request reviewers
+    if reviewers is not None:
+        print(f"Requesting reviewers '{reviewers}'")
+        try:
+            pull_request.create_review_request(reviewers=cs_string_to_list(reviewers))
+        except GithubException as e:
+            # Likely caused by "Review cannot be requested from pull request author."
+            if e.status == 422:
+                print("Request reviewers failed - {}".format(e.data["message"]))
+
+    # Set pull request team reviewers
+    if team_reviewers is not None:
+        print(f"Requesting team reviewers '{team_reviewers}'")
+        pull_request.create_review_request(
+            team_reviewers=cs_string_to_list(team_reviewers)
+        )
+
+    # Create a project card for the pull request
+    if project_name is not None and project_column_name is not None:
+        try:
+            create_project_card(
+                github_repo, project_name, project_column_name, pull_request
+            )
+        except GithubException as e:
+            # Likely caused by "Project already has the associated issue."
+            if e.status == 422:
+                print(
+                    "Create project card failed - {}".format(
+                        e.data["errors"][0]["message"]
+                    )
+                )

src/cpr/create_pull_request.py

@@ -0,0 +1,229 @@
+#!/usr/bin/env python3
+""" Create Pull Request """
+import base64
+import common as cmn
+import create_or_update_branch as coub
+import create_or_update_pull_request as coupr
+from git import Repo, GitCommandError
+import json
+import os
+import sys
+import time
+
+
+# Default the committer and author to the GitHub Actions bot
+DEFAULT_COMMITTER = "GitHub <noreply@github.com>"
+DEFAULT_AUTHOR = (
+    "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+)
+DEFAULT_COMMIT_MESSAGE = "[create-pull-request] automated change"
+DEFAULT_TITLE = "Changes by create-pull-request action"
+DEFAULT_BODY = (
+    "Automated changes by "
+    + "[create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action"
+)
+DEFAULT_BRANCH = "create-pull-request/patch"
+
+
+def get_git_config_value(repo, name):
+    try:
+        return repo.git.config("--get", name)
+    except GitCommandError:
+        return None
+
+
+def get_repository_detail(repo):
+    remote_origin_url = get_git_config_value(repo, "remote.origin.url")
+    if remote_origin_url is None:
+        raise ValueError("Failed to fetch 'remote.origin.url' from git config")
+    protocol, github_repository = cmn.parse_github_repository(remote_origin_url)
+    return remote_origin_url, protocol, github_repository
+
+
+def git_user_config_is_set(repo):
+    name = get_git_config_value(repo, "user.name")
+    email = get_git_config_value(repo, "user.email")
+
+    if name is not None and email is not None:
+        print(f"Git user already configured as '{name} <{email}>'")
+        return True
+
+    committer_name = get_git_config_value(repo, "committer.name")
+    committer_email = get_git_config_value(repo, "committer.email")
+    author_name = get_git_config_value(repo, "author.name")
+    author_email = get_git_config_value(repo, "author.email")
+
+    if (
+        committer_name is not None
+        and committer_email is not None
+        and author_name is not None
+        and author_email is not None
+    ):
+        print(
+            f"Git committer already configured as '{committer_name} <{committer_email}>'"
+        )
+        print(f"Git author already configured as '{author_name} <{author_email}>'")
+        return True
+
+    return False
+
+
+def set_committer_author(repo, committer, author):
+    # If either committer or author is supplied they will be cross used
+    if committer is None and author is not None:
+        print("Supplied author will also be used as the committer.")
+        committer = author
+    if author is None and committer is not None:
+        print("Supplied committer will also be used as the author.")
+        author = committer
+
+    # If no committer/author has been supplied but user configuration already
+    # exists in git config we can exit and use the existing config as-is.
+    if committer is None and author is None:
+        if git_user_config_is_set(repo):
+            return
+
+    # Set defaults if no committer/author has been supplied
+    if committer is None and author is None:
+        committer = DEFAULT_COMMITTER
+        author = DEFAULT_AUTHOR
+
+    # Set git environment. This will not persist after the action completes.
+    committer_name, committer_email = cmn.parse_display_name_email(committer)
+    author_name, author_email = cmn.parse_display_name_email(author)
+    repo.git.update_environment(
+        GIT_COMMITTER_NAME=committer_name,
+        GIT_COMMITTER_EMAIL=committer_email,
+        GIT_AUTHOR_NAME=author_name,
+        GIT_AUTHOR_EMAIL=author_email,
+    )
+    print(f"Configured git committer as '{committer_name} <{committer_email}>'")
+    print(f"Configured git author as '{author_name} <{author_email}>'")
+
+
+# Get required environment variables
+github_token = os.environ["GITHUB_TOKEN"]
+# Get environment variables with defaults
+path = os.getenv("CPR_PATH", os.getcwd())
+branch = os.getenv("CPR_BRANCH", DEFAULT_BRANCH)
+commit_message = os.getenv("CPR_COMMIT_MESSAGE", DEFAULT_COMMIT_MESSAGE)
+# Get environment variables with a default of 'None'
+committer = os.environ.get("CPR_COMMITTER")
+author = os.environ.get("CPR_AUTHOR")
+base = os.environ.get("CPR_BASE")
+
+# Set the repo path
+repo = Repo(path)
+
+# Determine the GitHub repository from git config
+# This will be the target repository for the pull request
+repo_url, protocol, github_repository = get_repository_detail(repo)
+print(f"Target repository set to {github_repository}")
+
+if protocol == "HTTPS":
+    print(f"::debug::Using HTTPS protocol")
+    # Encode and configure the basic credential for HTTPS access
+    basic_credential = base64.b64encode(
+        f"x-access-token:{github_token}".encode("utf-8")
+    ).decode("utf-8")
+    # Mask the basic credential in logs and debug output
+    print(f"::add-mask::{basic_credential}")
+    repo.git.set_persistent_git_options(
+        c=f"http.https://github.com/.extraheader=AUTHORIZATION: basic {basic_credential}"
+    )
+
+# 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
+try:
+    working_base = repo.git.symbolic_ref("HEAD", "--short")
+except GitCommandError as e:
+    print(f"::debug::{e.stderr}")
+    print(
+        f"::error::The checked out ref is not a valid base for a pull request. "
+        + "Unable to continue. Exiting."
+    )
+    sys.exit(1)
+
+# Exit if the working base is a PR branch created by this action.
+# This may occur when using a PAT instead of GITHUB_TOKEN because
+# a PAT allows workflow actions to trigger further events.
+if working_base.startswith(branch):
+    print(
+        f"::error::Working base branch '{working_base}' was created by this action. "
+        + "Unable to continue. Exiting."
+    )
+    sys.exit(1)
+
+# Fetch an optional environment variable to determine the branch suffix
+branch_suffix = os.environ.get("CPR_BRANCH_SUFFIX")
+if branch_suffix is not None:
+    if branch_suffix == "short-commit-hash":
+        # Suffix with the short SHA1 hash
+        branch = "{}-{}".format(branch, repo.git.rev_parse("--short", "HEAD"))
+    elif branch_suffix == "timestamp":
+        # Suffix with the current timestamp
+        branch = "{}-{}".format(branch, int(time.time()))
+    elif branch_suffix == "random":
+        # Suffix with a 7 character random string
+        branch = "{}-{}".format(branch, cmn.get_random_string())
+    else:
+        print(
+            f"::error::Branch suffix '{branch_suffix}' is not a valid value. "
+            + "Unable to continue. Exiting."
+        )
+        sys.exit(1)
+
+# Output head branch
+print(f"Pull request branch to create or update set to '{branch}'")
+
+# Set the committer and author
+try:
+    set_committer_author(repo, committer, author)
+except ValueError as e:
+    print(f"::error::{e} " + "Unable to continue. Exiting.")
+    sys.exit(1)
+
+# Create or update the pull request branch
+result = coub.create_or_update_branch(repo, repo_url, commit_message, base, branch)
+
+if result["action"] in ["created", "updated"]:
+    # The branch was created or updated
+    print(f"Pushing pull request branch to 'origin/{branch}'")
+    repo.git.push("--force", repo_url, f"HEAD:refs/heads/{branch}")
+
+    # Set the base. It would have been 'None' if not specified as an input
+    base = result["base"]
+
+    # If there is no longer a diff with the base delete the branch and exit
+    if not result["diff"]:
+        print(f"Branch '{branch}' no longer differs from base branch '{base}'")
+        print(f"Closing pull request and deleting branch '{branch}'")
+        repo.git.push("--delete", "--force", repo_url, f"refs/heads/{branch}")
+        sys.exit()
+
+    # Fetch optional environment variables with default values
+    title = os.getenv("CPR_TITLE", DEFAULT_TITLE)
+    body = os.getenv("CPR_BODY", DEFAULT_BODY)
+
+    # Create or update the pull request
+    coupr.create_or_update_pull_request(
+        github_token,
+        github_repository,
+        branch,
+        base,
+        title,
+        body,
+        os.environ.get("CPR_LABELS"),
+        os.environ.get("CPR_ASSIGNEES"),
+        os.environ.get("CPR_MILESTONE"),
+        os.environ.get("CPR_REVIEWERS"),
+        os.environ.get("CPR_TEAM_REVIEWERS"),
+        os.environ.get("CPR_PROJECT_NAME"),
+        os.environ.get("CPR_PROJECT_COLUMN_NAME"),
+        os.environ.get("CPR_DRAFT"),
+        os.environ.get("CPR_REQUEST_TO_PARENT"),
+    )

src/cpr/requirements.txt

@@ -0,0 +1,4 @@
+setuptools==46.4.0
+wheel==0.34.2
+GitPython==3.1.2
+PyGithub==1.51

src/cpr/test_common.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python3
+""" Test Common """
+import common as cmn
+import pytest
+
+
+def test_get_random_string():
+    assert len(cmn.get_random_string()) == 7
+    assert len(cmn.get_random_string(length=20)) == 20
+
+
+def test_parse_github_repository_success():
+    protocol, repository = cmn.parse_github_repository(
+        "https://github.com/peter-evans/create-pull-request"
+    )
+    assert protocol == "HTTPS"
+    assert repository == "peter-evans/create-pull-request"
+
+    protocol, repository = cmn.parse_github_repository(
+        "https://xxx:x-oauth-basic@github.com/peter-evans/create-pull-request"
+    )
+    assert protocol == "HTTPS"
+    assert repository == "peter-evans/create-pull-request"
+
+    protocol, repository = cmn.parse_github_repository(
+        "git@github.com:peter-evans/create-pull-request.git"
+    )
+    assert protocol == "SSH"
+    assert repository == "peter-evans/create-pull-request"
+
+
+def test_parse_github_repository_failure():
+    url = "https://github.com/peter-evans"
+    with pytest.raises(ValueError) as e_info:
+        cmn.parse_github_repository(url)
+    assert (
+        e_info.value.args[0]
+        == f"The format of '{url}' is not a valid GitHub repository URL"
+    )
+
+
+def test_parse_display_name_email_success():
+    name, email = cmn.parse_display_name_email("abc def <abc@def.com>")
+    assert name == "abc def"
+    assert email == "abc@def.com"
+
+    name, email = cmn.parse_display_name_email(
+        "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+    )
+    assert name == "github-actions[bot]"
+    assert email == "41898282+github-actions[bot]@users.noreply.github.com"
+
+
+def test_parse_display_name_email_failure():
+    display_name_email = "abc@def.com"
+    with pytest.raises(ValueError) as e_info:
+        cmn.parse_display_name_email(display_name_email)
+    assert (
+        e_info.value.args[0]
+        == f"The format of '{display_name_email}' is not a valid email address with display name"
+    )
+
+    display_name_email = " < >"
+    with pytest.raises(ValueError) as e_info:
+        cmn.parse_display_name_email(display_name_email)
+    assert (
+        e_info.value.args[0]
+        == f"The format of '{display_name_email}' is not a valid email address with display name"
+    )

src/cpr/test_create_or_update_branch.py

@@ -0,0 +1,757 @@
+#!/usr/bin/env python3
+""" Test Create or Update Branch """
+import create_or_update_branch as coub
+from git import Repo
+import os
+import pytest
+import sys
+import time
+
+
+# Set git repo
+REPO_PATH = os.getenv("COUB_REPO_PATH", os.getcwd())
+repo = Repo(REPO_PATH)
+
+# Set git environment
+author_name = "github-actions[bot]"
+author_email = "41898282+github-actions[bot]@users.noreply.github.com"
+committer_name = "GitHub"
+committer_email = "noreply@github.com"
+repo.git.update_environment(
+    GIT_AUTHOR_NAME=author_name,
+    GIT_AUTHOR_EMAIL=author_email,
+    GIT_COMMITTER_NAME=committer_name,
+    GIT_COMMITTER_EMAIL=committer_email,
+)
+
+REPO_URL = repo.git.config("--get", "remote.origin.url")
+
+TRACKED_FILE = "tracked-file.txt"
+UNTRACKED_FILE = "untracked-file.txt"
+
+DEFAULT_BRANCH = "tests/master"
+NOT_BASE_BRANCH = "tests/branch-that-is-not-the-base"
+NOT_EXIST_BRANCH = "tests/branch-that-does-not-exist"
+
+COMMIT_MESSAGE = "[create-pull-request] automated change"
+BRANCH = "tests/create-pull-request/patch"
+BASE = DEFAULT_BRANCH
+
+
+def create_tracked_change(content=None):
+    if content is None:
+        content = str(time.time())
+    # Create a tracked file change
+    with open(os.path.join(REPO_PATH, TRACKED_FILE), "w") as f:
+        f.write(content)
+    return content
+
+
+def create_untracked_change(content=None):
+    if content is None:
+        content = str(time.time())
+    # Create an untracked file change
+    with open(os.path.join(REPO_PATH, UNTRACKED_FILE), "w") as f:
+        f.write(content)
+    return content
+
+
+def get_tracked_content():
+    # Read the content of the tracked file
+    with open(os.path.join(REPO_PATH, TRACKED_FILE), "r") as f:
+        return f.read()
+
+
+def get_untracked_content():
+    # Read the content of the untracked file
+    with open(os.path.join(REPO_PATH, UNTRACKED_FILE), "r") as f:
+        return f.read()
+
+
+def create_changes(tracked_content=None, untracked_content=None):
+    tracked_content = create_tracked_change(tracked_content)
+    untracked_content = create_untracked_change(untracked_content)
+    return tracked_content, untracked_content
+
+
+def create_commits(number=2, final_tracked_content=None, final_untracked_content=None):
+    for i in range(number):
+        commit_number = i + 1
+        if commit_number == number:
+            tracked_content, untracked_content = create_changes(
+                final_tracked_content, final_untracked_content
+            )
+        else:
+            tracked_content, untracked_content = create_changes()
+        repo.git.add("-A")
+        repo.git.commit(m=f"Commit {commit_number}")
+    return tracked_content, untracked_content
+
+
+@pytest.fixture(scope="module", autouse=True)
+def before_after_all():
+    print("Before all tests")
+    # Check there are no local changes that might be
+    # destroyed by running these tests
+    assert not repo.is_dirty(untracked_files=True)
+
+    # Create a new default branch for the test run
+    repo.remotes.origin.fetch()
+    repo.git.checkout("master")
+    repo.git.checkout("HEAD", b=NOT_BASE_BRANCH)
+    create_tracked_change()
+    repo.git.add("-A")
+    repo.git.commit(m="This commit should not appear in pr branches")
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{NOT_BASE_BRANCH}")
+    # Create a new default branch for the test run
+    repo.git.checkout("master")
+    repo.git.checkout("HEAD", b=DEFAULT_BRANCH)
+    create_tracked_change()
+    repo.git.add("-A")
+    repo.git.commit(m="Add file to be a tracked file for tests")
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+
+    yield
+
+    print("After all tests")
+    repo.git.checkout("master")
+    # Delete the "not base branch" created for the test run
+    repo.git.branch("--delete", "--force", NOT_BASE_BRANCH)
+    repo.git.push("--delete", "--force", REPO_URL, f"refs/heads/{NOT_BASE_BRANCH}")
+    # Delete the default branch created for the test run
+    repo.git.branch("--delete", "--force", DEFAULT_BRANCH)
+    repo.git.push("--delete", "--force", REPO_URL, f"refs/heads/{DEFAULT_BRANCH}")
+
+
+def before_test():
+    print("Before test")
+    # Checkout the default branch
+    repo.git.checkout(DEFAULT_BRANCH)
+
+
+def after_test(delete_remote=True):
+    print("After test")
+    # Output git log
+    print(repo.git.log("-5", pretty="oneline"))
+    # Delete the pull request branch if it exists
+    repo.git.checkout(DEFAULT_BRANCH)
+    print(f"Deleting {BRANCH}")
+    for branch in repo.branches:
+        if branch.name == BRANCH:
+            repo.git.branch("--delete", "--force", BRANCH)
+            break
+    if delete_remote:
+        print(f"Deleting origin/{BRANCH}")
+        for ref in repo.remotes.origin.refs:
+            if ref.name == f"origin/{BRANCH}":
+                repo.git.push("--delete", "--force", REPO_URL, f"refs/heads/{BRANCH}")
+                repo.remotes.origin.fetch("--prune")
+                break
+
+
+@pytest.fixture(autouse=True)
+def before_after_tests():
+    before_test()
+    yield
+    after_test()
+
+
+# Tests if a branch exists and can be fetched
+def coub_fetch_successful():
+    assert coub.fetch_successful(repo, REPO_URL, NOT_BASE_BRANCH)
+    assert not coub.fetch_successful(repo, REPO_URL, NOT_EXIST_BRANCH)
+
+
+# Tests no changes resulting in no new branch being created
+def coub_no_changes_on_create():
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "none"
+
+
+# Tests create and update with a tracked file change
+def coub_tracked_changes():
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+
+
+# Tests create and update with an untracked file change
+def coub_untracked_changes():
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with identical changes
+# The pull request branch will not be updated
+def coub_identical_changes():
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create identical tracked and untracked file changes
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "none"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with commits on the base inbetween
+def coub_commits_on_base():
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and then an update with no changes
+# This effectively reverts the branch back to match the base and results in no diff
+def coub_changes_no_diff():
+    # Save the default branch tracked content
+    default_tracked_content = get_tracked_content()
+
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Running with no update effectively reverts the branch back to match the base
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == default_tracked_content
+
+
+# Tests create and update with commits on the base inbetween
+# The changes on base effectively revert the branch back to match the base and results in no diff
+def coub_commits_on_base_no_diff():
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    tracked_content, untracked_content = create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Create the same tracked and untracked file changes that were made to the base
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with commits on the working base (during the workflow)
+def coub_commits_on_working_base():
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with changes and commits on the working base (during the workflow)
+def coub_changes_and_commits_on_working_base():
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Tests create and update with changes and commits on the working base (during the workflow)
+# with commits on the base inbetween
+def coub_changes_and_commits_on_base_and_working_base():
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, None, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests no changes resulting in no new branch being created
+def coub_wbnb_no_changes_on_create():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "none"
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with a tracked file change
+def coub_wbnb_tracked_changes():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create a tracked file change
+    tracked_content = create_tracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with an untracked file change
+def coub_wbnb_untracked_changes():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create an untracked file change
+    untracked_content = create_untracked_change()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with identical changes
+# The pull request branch will not be updated
+def coub_wbnb_identical_changes():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create identical tracked and untracked file changes
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "none"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with commits on the base inbetween
+def coub_wbnb_commits_on_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and then an update with no changes
+# This effectively reverts the branch back to match the base and results in no diff
+def coub_wbnb_changes_no_diff():
+    # Save the default branch tracked content
+    default_tracked_content = get_tracked_content()
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Running with no update effectively reverts the branch back to match the base
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == default_tracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with commits on the base inbetween
+# The changes on base effectively revert the branch back to match the base and results in no diff
+# This scenario will cause cherrypick to fail due to an empty commit.
+# The commit is empty because the changes now exist on the base.
+def coub_wbnb_commits_on_base_no_diff():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    tracked_content, untracked_content = create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create the same tracked and untracked file changes that were made to the base
+    create_changes(tracked_content, untracked_content)
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"] == False
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with commits on the working base (during the workflow)
+def coub_wbnb_commits_on_working_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    tracked_content, untracked_content = create_commits()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with changes and commits on the working base (during the workflow)
+def coub_wbnb_changes_and_commits_on_working_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# Working Base is Not Base (WBNB)
+# Tests create and update with changes and commits on the working base (during the workflow)
+# with commits on the base inbetween
+def coub_wbnb_changes_and_commits_on_base_and_working_base():
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "created"
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+    # Push pull request branch to remote
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{BRANCH}")
+    repo.remotes.origin.fetch()
+
+    after_test(delete_remote=False)
+    before_test()
+
+    # Create commits on the base
+    create_commits()
+    repo.git.push("--force", REPO_URL, f"HEAD:refs/heads/{DEFAULT_BRANCH}")
+    repo.remotes.origin.fetch()
+
+    # Set the working base to a branch that is not the pull request base
+    repo.git.checkout(NOT_BASE_BRANCH)
+    # Create commits on the working base
+    create_commits()
+    # Create tracked and untracked file changes
+    tracked_content, untracked_content = create_changes()
+    result = coub.create_or_update_branch(repo, REPO_URL, COMMIT_MESSAGE, BASE, BRANCH)
+    assert result["action"] == "updated"
+    assert result["diff"]
+    assert get_tracked_content() == tracked_content
+    assert get_untracked_content() == untracked_content
+
+
+# pytest -v -s ~/git/create-pull-request/src
+
+test_coub_fetch_successful = coub_fetch_successful
+
+test_coub_no_changes_on_create = coub_no_changes_on_create
+test_coub_tracked_changes = coub_tracked_changes
+test_coub_untracked_changes = coub_untracked_changes
+test_coub_identical_changes = coub_identical_changes
+test_coub_commits_on_base = coub_commits_on_base
+
+test_coub_changes_no_diff = coub_changes_no_diff
+test_coub_commits_on_base_no_diff = coub_commits_on_base_no_diff
+
+test_coub_commits_on_working_base = coub_commits_on_working_base
+test_coub_changes_and_commits_on_working_base = coub_changes_and_commits_on_working_base
+test_coub_changes_and_commits_on_base_and_working_base = (
+    coub_changes_and_commits_on_base_and_working_base
+)
+
+# WBNB
+test_coub_wbnb_no_changes_on_create = coub_wbnb_no_changes_on_create
+test_coub_wbnb_tracked_changes = coub_wbnb_tracked_changes
+test_coub_wbnb_untracked_changes = coub_wbnb_untracked_changes
+test_coub_wbnb_identical_changes = coub_wbnb_identical_changes
+test_coub_wbnb_commits_on_base = coub_wbnb_commits_on_base
+
+test_coub_wbnb_changes_no_diff = coub_wbnb_changes_no_diff
+test_coub_wbnb_commits_on_base_no_diff = coub_wbnb_commits_on_base_no_diff
+
+test_coub_wbnb_commits_on_working_base = coub_wbnb_commits_on_working_base
+test_coub_wbnb_changes_and_commits_on_working_base = (
+    coub_wbnb_changes_and_commits_on_working_base
+)
+test_coub_wbnb_changes_and_commits_on_base_and_working_base = (
+    coub_wbnb_changes_and_commits_on_base_and_working_base
+)

src/git.ts

@@ -0,0 +1,121 @@
+import * as core from '@actions/core'
+import * as exec from '@actions/exec'
+import * as path from 'path'
+
+class GitOutput {
+  stdout = ''
+  exitCode = 0
+}
+
+export class ConfigOption {
+  name = ''
+  value = ''
+}
+
+export function getRepoPath(relativePath?: string): string {
+  let githubWorkspacePath = process.env['GITHUB_WORKSPACE']
+  if (!githubWorkspacePath) {
+    throw new Error('GITHUB_WORKSPACE not defined')
+  }
+  githubWorkspacePath = path.resolve(githubWorkspacePath)
+  core.debug(`githubWorkspacePath: ${githubWorkspacePath}`)
+
+  let repoPath = githubWorkspacePath
+  if (relativePath) repoPath = path.resolve(repoPath, relativePath)
+
+  core.debug(`repoPath: ${repoPath}`)
+  return repoPath
+}
+
+export async function execGit(
+  repoPath: string,
+  args: string[],
+  ignoreReturnCode = false
+): Promise<GitOutput> {
+  const result = new GitOutput()
+
+  const stdout: string[] = []
+  const options = {
+    cwd: repoPath,
+    ignoreReturnCode: ignoreReturnCode,
+    listeners: {
+      stdout: (data: Buffer): void => {
+        stdout.push(data.toString())
+      }
+    }
+  }
+
+  result.exitCode = await exec.exec('git', args, options)
+  result.stdout = stdout.join('')
+  return result
+}
+
+export async function addConfigOption(
+  repoPath: string,
+  name: string,
+  value: string
+): Promise<boolean> {
+  const result = await execGit(
+    repoPath,
+    ['config', '--local', '--add', name, value],
+    true
+  )
+  return result.exitCode === 0
+}
+
+export async function unsetConfigOption(
+  repoPath: string,
+  name: string,
+  valueRegex = '.'
+): Promise<boolean> {
+  const result = await execGit(
+    repoPath,
+    ['config', '--local', '--unset', name, valueRegex],
+    true
+  )
+  return result.exitCode === 0
+}
+
+export async function configOptionExists(
+  repoPath: string,
+  name: string,
+  valueRegex = '.'
+): Promise<boolean> {
+  const result = await execGit(
+    repoPath,
+    ['config', '--local', '--name-only', '--get-regexp', name, valueRegex],
+    true
+  )
+  return result.exitCode === 0
+}
+
+export async function getConfigOption(
+  repoPath: string,
+  name: string,
+  valueRegex = '.'
+): Promise<ConfigOption> {
+  const option = new ConfigOption()
+  const result = await execGit(
+    repoPath,
+    ['config', '--local', '--get-regexp', name, valueRegex],
+    true
+  )
+  option.name = name
+  option.value = result.stdout.trim().split(`${name} `)[1]
+  return option
+}
+
+export async function getAndUnsetConfigOption(
+  repoPath: string,
+  name: string,
+  valueRegex = '.'
+): Promise<ConfigOption> {
+  if (await configOptionExists(repoPath, name, valueRegex)) {
+    const option = await getConfigOption(repoPath, name, valueRegex)
+    if (await unsetConfigOption(repoPath, name, valueRegex)) {
+      core.debug(`Unset config option '${name}'`)
+      return option
+    }
+  }
+  return new ConfigOption()
+}

src/isDocker.ts

@@ -0,0 +1,22 @@
+import * as fs from 'fs'
+
+function hasDockerEnv(): boolean {
+  try {
+    fs.statSync('/.dockerenv')
+    return true
+  } catch (_) {
+    return false
+  }
+}
+
+function hasDockerCGroup(): boolean {
+  try {
+    return fs.readFileSync('/proc/self/cgroup', 'utf8').includes('docker')
+  } catch (_) {
+    return false
+  }
+}
+
+export function isDocker(): boolean {
+  return hasDockerEnv() || hasDockerCGroup()
+}

src/main.ts

@@ -0,0 +1,129 @@
+import * as core from '@actions/core'
+import * as exec from '@actions/exec'
+import {isDocker} from './isDocker'
+import {setupPython} from './setupPython'
+import {
+  ConfigOption,
+  getRepoPath,
+  getAndUnsetConfigOption,
+  addConfigOption
+} from './git'
+import {inspect} from 'util'
+
+const EXTRAHEADER_OPTION = 'http.https://github.com/.extraheader'
+const EXTRAHEADER_VALUE_REGEX = '^AUTHORIZATION:'
+
+async function run(): Promise<void> {
+  let repoPath
+  let extraHeaderOption = new ConfigOption()
+  try {
+    // Python assets
+    const cpr = `${__dirname}/cpr`
+    core.debug(`cpr: ${cpr}`)
+
+    // Determine how to access python and pip
+    const {pip, python} = (function (): {pip: string; python: string} {
+      if (isDocker()) {
+        core.info('Running inside a Docker container')
+        // Python 3 assumed to be installed and on the PATH
+        return {
+          pip: 'pip3',
+          python: 'python3'
+        }
+      } else {
+        // Setup Python from the tool cache
+        setupPython('3.x', 'x64')
+        return {
+          pip: 'pip',
+          python: 'python'
+        }
+      }
+    })()
+
+    // Install requirements
+    await exec.exec(pip, [
+      'install',
+      '--requirement',
+      `${cpr}/requirements.txt`,
+      '--no-index',
+      `--find-links=${__dirname}/vendor`
+    ])
+
+    // Fetch action inputs
+    const inputs = {
+      token: core.getInput('token'),
+      path: core.getInput('path'),
+      commitMessage: core.getInput('commit-message'),
+      committer: core.getInput('committer'),
+      author: core.getInput('author'),
+      title: core.getInput('title'),
+      body: core.getInput('body'),
+      labels: core.getInput('labels'),
+      assignees: core.getInput('assignees'),
+      reviewers: core.getInput('reviewers'),
+      teamReviewers: core.getInput('team-reviewers'),
+      milestone: core.getInput('milestone'),
+      project: core.getInput('project'),
+      projectColumn: core.getInput('project-column'),
+      draft: core.getInput('draft'),
+      branch: core.getInput('branch'),
+      requestToParent: core.getInput('request-to-parent'),
+      base: core.getInput('base'),
+      branchSuffix: core.getInput('branch-suffix')
+    }
+    core.debug(`Inputs: ${inspect(inputs)}`)
+
+    // Set environment variables from inputs.
+    if (inputs.token) process.env.GITHUB_TOKEN = inputs.token
+    if (inputs.path) process.env.CPR_PATH = inputs.path
+    if (inputs.commitMessage)
+      process.env.CPR_COMMIT_MESSAGE = inputs.commitMessage
+    if (inputs.committer) process.env.CPR_COMMITTER = inputs.committer
+    if (inputs.author) process.env.CPR_AUTHOR = inputs.author
+    if (inputs.title) process.env.CPR_TITLE = inputs.title
+    if (inputs.body) process.env.CPR_BODY = inputs.body
+    if (inputs.labels) process.env.CPR_LABELS = inputs.labels
+    if (inputs.assignees) process.env.CPR_ASSIGNEES = inputs.assignees
+    if (inputs.reviewers) process.env.CPR_REVIEWERS = inputs.reviewers
+    if (inputs.teamReviewers)
+      process.env.CPR_TEAM_REVIEWERS = inputs.teamReviewers
+    if (inputs.milestone) process.env.CPR_MILESTONE = inputs.milestone
+    if (inputs.project) process.env.CPR_PROJECT_NAME = inputs.project
+    if (inputs.projectColumn)
+      process.env.CPR_PROJECT_COLUMN_NAME = inputs.projectColumn
+    if (inputs.draft) process.env.CPR_DRAFT = inputs.draft
+    if (inputs.branch) process.env.CPR_BRANCH = inputs.branch
+    if (inputs.requestToParent)
+      process.env.CPR_REQUEST_TO_PARENT = inputs.requestToParent
+    if (inputs.base) process.env.CPR_BASE = inputs.base
+    if (inputs.branchSuffix) process.env.CPR_BRANCH_SUFFIX = inputs.branchSuffix
+
+    // Get the repository path
+    repoPath = getRepoPath(inputs.path)
+    // Get the extraheader config option if it exists
+    extraHeaderOption = await getAndUnsetConfigOption(
+      repoPath,
+      EXTRAHEADER_OPTION,
+      EXTRAHEADER_VALUE_REGEX
+    )
+
+    // Execute create pull request
+    await exec.exec(python, [`${cpr}/create_pull_request.py`])
+  } catch (error) {
+    core.setFailed(error.message)
+  } finally {
+    // Restore the extraheader config option
+    if (extraHeaderOption.value != '') {
+      if (
+        await addConfigOption(
+          repoPath,
+          EXTRAHEADER_OPTION,
+          extraHeaderOption.value
+        )
+      )
+        core.debug(`Restored config option '${EXTRAHEADER_OPTION}'`)
+    }
+  }
+}
+
+run()

src/setupPython.ts

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

tsconfig.json

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