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

Update distribution

.eslintignore

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

.eslintrc.json

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

.github/CODEOWNERS

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

.github/workflows/ci.yml

@@ -2,8 +2,14 @@ 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
@@ -17,31 +23,41 @@ jobs:
           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:
-      - if: github.event_name == 'push'
+      - uses: actions/checkout@v2
-        uses: actions/checkout@v2
-      - if: github.event_name == 'pull_request'
-        uses: actions/checkout@v2
         with:
-          ref: ${{ github.head_ref }}
+          ref: master
-      - if: matrix.target == 'built'
+      - 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
@@ -65,7 +81,7 @@ jobs:
       - name: Close Pull
         uses: peter-evans/close-pull@v1
         with:
-          pull-request-number: ${{ steps.cpr.outputs.pr_number }}
+          pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
           comment: '[CI] test ${{ matrix.target }}'
           delete-branch: true
 
@@ -99,6 +115,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - run: rm -rf dist
       - uses: actions/download-artifact@v2
         with:
           name: dist

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

@@ -7,8 +7,10 @@ jobs:
     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: ./
@@ -27,15 +29,15 @@ jobs:
           assignees: peter-evans
           reviewers: peter-evans
           milestone: 1
-          project: Example Project
-          project-column: To do
           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.pr_number }}"
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+
       - name: Add reaction
         uses: peter-evans/create-or-update-comment@v1
         with:

.github/workflows/dockerhub-description.yml

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

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

@@ -9,8 +9,7 @@ jobs:
       - name: Slash Command Dispatch
         uses: peter-evans/slash-command-dispatch@v1
         with:
-          token: ${{ secrets.REPO_ACCESS_TOKEN }}
+          token: ${{ secrets.ACTIONS_BOT_TOKEN }}
-          reaction-token: ${{ secrets.GITHUB_TOKEN }}
           config: >
             [
               {
@@ -34,5 +33,11 @@ jobs:
                 "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,6 +1,7 @@
 __pycache__
 .python-version
 
-node_modules
+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"
+}

README.md

@@ -1,4 +1,5 @@
 # <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.
@@ -51,15 +52,15 @@ All inputs are **optional**. If not set, sensible default values will be used.
 | `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` | The name of the project for which a card should be created. Requires `project-column`. | |
+| `project` | *Deprecated*. See [Create a project card](#create-a-project-card) for details. | |
-| `project-column` | The name of the project column under which a card should be created. Requires `project`. | |
+| `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 [Branch naming](#branch-naming) for details. | `create-pull-request/patch` |
+| `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 [Branch naming](#branch-naming) for details. | |
+| `branch-suffix` | The branch suffix type. Valid values are `random`, `timestamp` and `short-commit-hash`. See [Action behaviour](#action-behaviour) for details. | |
 
-**Outputs**
+### 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.
@@ -71,7 +72,7 @@ Note that in order to read the step output the action step must have an id.
       - name: Check outputs
         run: |
           echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
 ```
 
 ### Checkout
@@ -85,20 +86,29 @@ If there is some reason you need to use `actions/checkout@v1` the following step
       - run: git checkout "${GITHUB_REF:11}"
 ```
 
-### Branch naming
+### Action behaviour
 
-For branch naming there are two strategies. Create a fixed-name pull request branch that will be updated with new changes until it is merged or closed, OR, always create a new unique branch each time there are changes to be committed.
+The default behaviour of the action is to create a pull request that will be continually updated with new changes until it is merged or closed.
+Changes are committed and pushed to a fixed-name branch, the name of which can be configured with the `branch` input.
+Any subsequent changes will be committed to the *same* branch and reflected in the open pull request.
 
-#### Strategy A - Create and update a pull request branch (default)
+How the action behaves:
 
-This strategy is the default behaviour of the action. The input `branch` defaults to `create-pull-request/patch`. Changes will be committed to this branch and a pull request created. Any subsequent changes will be committed to the *same* branch and reflected in the open pull request. If the pull request is merged or closed a new one will be created. If subsequent changes cause the branch to no longer differ from the base the pull request will be automatically closed and the branch deleted.
+- 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.
 
-#### Strategy B - Always create a new pull request branch
+For further details about how the action works and usage guidelines, see [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md).
 
-For this strategy there are three options to suffix the branch name.
+#### Alternative strategy - Always create a new pull request branch
-The branch name is defined by the input `branch` and defaults to `create-pull-request/patch`. The following options are values for `branch-suffix`.
 
-- `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`
+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.
+
+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`
 
@@ -143,6 +153,23 @@ As well as relying on the action to handle uncommitted changes, you can addition
         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.
@@ -179,18 +206,16 @@ jobs:
           reviewers: peter-evans
           team-reviewers: owners, maintainers
           milestone: 1
-          project: Example Project
-          project-column: To do
           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.pr_number }}"
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
 ```
 
-This reference configuration will create pull requests that look like this:
+An example based on the above reference configuration creates pull requests that look like this:
 
 ![Pull Request Example](docs/assets/pull-request-example.png)
 

__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

@@ -27,9 +27,11 @@ inputs:
   milestone:
     description: 'The number of the milestone to associate this pull request with.'
   project:
-    description: 'The name of the project for which a card should be created.'
+    description: 'Deprecated. See README for details.'
   project-column:
-    description: 'The name of the project column under which a card should be created.'
+    description: 'Deprecated. See README for details.'
+  draft:
+    description: 'Create a draft pull request'
   branch:
     description: 'The pull request branch name.'
   request-to-parent:
@@ -40,7 +42,7 @@ inputs:
   branch-suffix:
     description: 'The branch suffix type.'
 outputs:
-  pr_number:
+  pull-request-number:
     description: 'The pull request number'
 runs:
   using: 'node12'

dist/cpr/common.py

@@ -11,7 +11,7 @@ def get_random_string(length=7, chars=string.ascii_lowercase + string.digits):
 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/(.+/.+)$")
+    https_pattern = re.compile(r"^https://.*@?github.com/(.+/.+)$")
     ssh_pattern = re.compile(r"^git@github.com:(.+/.+).git$")
 
     match = https_pattern.match(url)

dist/cpr/create_or_update_pull_request.py

@@ -113,6 +113,8 @@ def create_or_update_pull_request(
 
     # 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

dist/cpr/requirements.txt

@@ -1,4 +1,4 @@
-setuptools==46.1.3
+setuptools==46.4.0
 wheel==0.34.2
-GitPython==3.1.1
+GitPython==3.1.2
-PyGithub==1.50
+PyGithub==1.51

dist/cpr/test_common.py

@@ -16,6 +16,12 @@ def test_parse_github_repository_success():
     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"
     )

docs/concepts-guidelines.md

@@ -90,7 +90,7 @@ Workflows triggered by `pull_request` events will by default check out a [merge
 
 ### Restrictions on forked repositories
 
-GitHub Actions have imposed restrictions on events triggered by a forked repository. For example, the `pull_request` event triggered by a fork opening a pull request in the upstream repository.
+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.
@@ -101,7 +101,7 @@ GitHub Actions have imposed restrictions on events triggered by a forked reposit
 
    [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 the action will be unable to commit changes to a branch.
+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.
 
@@ -206,7 +206,7 @@ It will use their own fork to push code and create the pull request.
 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-on-parent` to `true`.
+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
@@ -221,7 +221,7 @@ It will use their own fork to push code and create the pull request.
       - uses: peter-evans/create-pull-request@v2
         with:
           token: ${{ secrets.MACHINE_USER_PAT }}
-          request-on-parent: true
+          request-to-parent: true
 ```
 
 ### Running in a container
@@ -241,7 +241,9 @@ jobs:
       image: alpine
     steps:
       - name: Install dependencies
-        run: apk --no-cache add git python3
+        run: |
+          apk --no-cache add git python3
+          python3 -m ensurepip
 
       - uses: actions/checkout@v2
 

docs/examples.md

@@ -5,6 +5,7 @@
   - [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)
@@ -86,32 +87,100 @@ This pattern will work well for updating any kind of static content from an exte
 
 ### 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-deps:
+  update-dep:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: '12.x'
       - name: Update dependencies
-        id: vars
         run: |
-          npm install -g npm-check-updates
+          npx -p npm-check-updates ncu -u
-          ncu -u
           npm install
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v2
         with:
-          commit-message: update dependencies
+            token: ${{ secrets.PAT }}
-          title: Automated Dependency Updates
+            commit-message: Update dependencies
-          body: This is an auto-generated PR with dependency updates.
+            title: Update dependencies
-          branch: dep-updates
+            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
@@ -243,7 +312,7 @@ An `on: repository_dispatch` workflow can be triggered from another workflow wit
 
 ```yml
 - name: Repository Dispatch
-  uses: peter-evans/repository-dispatch@v1.0.0
+  uses: peter-evans/repository-dispatch@v1
   with:
     token: ${{ secrets.REPO_ACCESS_TOKEN }}
     repository: username/my-repo

jest.config.js

@@ -1,3 +1,11 @@
-process.env = Object.assign(process.env, {
+module.exports = {
-  GITHUB_WORKSPACE: __dirname
+  clearMocks: true,
-});
+  moduleFileExtensions: ['js', 'ts'],
+  testEnvironment: 'node',
+  testMatch: ['**/*.test.ts'],
+  testRunner: 'jest-circus/runner',
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  verbose: true
+}

package.json

@@ -1,21 +1,31 @@
 {
   "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": "index.js",
+  "main": "lib/main.js",
   "scripts": {
     "clean": "rm -rf dist",
-    "lint": "eslint src/index.js",
+    "build": "tsc && ncc build",
-    "test": "eslint src/index.js && jest",
+    "format": "prettier --write '**/*.ts'",
-    "build": "ncc build src/index.js -o dist",
+    "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 vendor-deps"
+    "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": [],
+  "keywords": [
+    "actions",
+    "pull",
+    "request"
+  ],
   "author": "Peter Evans",
   "license": "MIT",
   "bugs": {
@@ -23,14 +33,24 @@
   },
   "homepage": "https://github.com/peter-evans/create-pull-request",
   "dependencies": {
-    "@actions/core": "1.2.0",
+    "@actions/core": "1.2.4",
-    "@actions/exec": "1.0.2",
+    "@actions/exec": "1.0.4",
-    "@actions/tool-cache": "1.1.2",
+    "@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": "6.8.0",
+    "eslint": "7.0.0",
-    "jest": "25.5.3"
+    "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

@@ -2,10 +2,8 @@
   "extends": [
     "config:base"
   ],
-  "packageRules": [
+  "enabledManagers": ["pip_requirements"],
-    {
+  "ignorePaths": [
-      "depTypeList": ["devDependencies"],
+    "**/dist/**"
-      "automerge": true
-    }
   ]
 }

src/cpr/common.py

@@ -11,7 +11,7 @@ def get_random_string(length=7, chars=string.ascii_lowercase + string.digits):
 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/(.+/.+)$")
+    https_pattern = re.compile(r"^https://.*@?github.com/(.+/.+)$")
     ssh_pattern = re.compile(r"^git@github.com:(.+/.+).git$")
 
     match = https_pattern.match(url)

src/cpr/create_or_update_pull_request.py

@@ -113,6 +113,8 @@ def create_or_update_pull_request(
 
     # 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

src/cpr/requirements.txt

@@ -1,4 +1,4 @@
-setuptools==46.1.3
+setuptools==46.4.0
 wheel==0.34.2
-GitPython==3.1.1
+GitPython==3.1.2
-PyGithub==1.50
+PyGithub==1.51

src/cpr/test_common.py

@@ -16,6 +16,12 @@ def test_parse_github_repository_success():
     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"
     )

src/git.js

@@ -1,97 +0,0 @@
-const core = require("@actions/core");
-const exec = require("@actions/exec");
-const path = require("path");
-
-function getRepoPath(relativePath) {
-  let githubWorkspacePath = process.env["GITHUB_WORKSPACE"];
-  if (!githubWorkspacePath) {
-    throw new Error("GITHUB_WORKSPACE not defined");
-  }
-  githubWorkspacePath = path.resolve(githubWorkspacePath);
-  core.debug(`githubWorkspacePath: ${githubWorkspacePath}`);
-
-  repoPath = githubWorkspacePath;
-  if (relativePath) repoPath = path.resolve(repoPath, relativePath);
-
-  core.debug(`repoPath: ${repoPath}`);
-  return repoPath;
-}
-
-async function execGit(repoPath, args, ignoreReturnCode = false) {
-  const stdout = [];
-  const options = {
-    cwd: repoPath,
-    ignoreReturnCode: ignoreReturnCode,
-    listeners: {
-      stdout: data => {
-        stdout.push(data.toString());
-      }
-    }
-  };
-
-  var result = {};
-  result.exitCode = await exec.exec("git", args, options);
-  result.stdout = stdout.join("");
-  return result;
-}
-
-async function addConfigOption(repoPath, name, value) {
-  const result = await execGit(
-    repoPath,
-    ["config", "--local", "--add", name, value],
-    true
-  );
-  return result.exitCode === 0;
-}
-
-async function unsetConfigOption(repoPath, name, valueRegex=".") {
-  const result = await execGit(
-    repoPath,
-    ["config", "--local", "--unset", name, valueRegex],
-    true
-  );
-  return result.exitCode === 0;
-}
-
-async function configOptionExists(repoPath, name, valueRegex=".") {
-  const result = await execGit(
-    repoPath,
-    ["config", "--local", "--name-only", "--get-regexp", name, valueRegex],
-    true
-  );
-  return result.exitCode === 0;
-}
-
-async function getConfigOption(repoPath, name, valueRegex=".") {
-  const result = await execGit(
-    repoPath,
-    ["config", "--local", "--get-regexp", name, valueRegex],
-    true
-  );
-  const option = result.stdout.trim().split(`${name} `);
-  return {
-    name: name,
-    value: option[1]
-  }
-}
-
-async function getAndUnsetConfigOption(repoPath, name, valueRegex=".") {
-  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 null;
-}
-
-module.exports = {
-  getRepoPath,
-  execGit,
-  addConfigOption,
-  unsetConfigOption,
-  configOptionExists,
-  getConfigOption,
-  getAndUnsetConfigOption
-};

src/git.test.js

@@ -1,98 +0,0 @@
-const path = require("path");
-const {
-  getRepoPath,
-  execGit,
-  addConfigOption,
-  unsetConfigOption,
-  configOptionExists,
-  getConfigOption,
-  getAndUnsetConfigOption
-} = require("./git");
-
-test("getRepoPath", async () => {
-  expect(getRepoPath()).toEqual(process.env["GITHUB_WORKSPACE"]);
-  expect(getRepoPath("foo")).toEqual(
-    path.resolve(process.env["GITHUB_WORKSPACE"], "foo")
-  );
-});
-
-test("execGit", 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");
-});
-
-test("add and unset 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();
-});
-
-test("add and unset 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();
-});
-
-test("configOptionExists returns true", async () => {
-  const repoPath = getRepoPath();
-  const result = await configOptionExists(repoPath, "remote.origin.url");
-  expect(result).toBeTruthy();
-});
-
-test("configOptionExists returns false", async () => {
-  const repoPath = getRepoPath();
-  const result = await configOptionExists(repoPath, "this.key.does.not.exist");
-  expect(result).toBeFalsy();
-});
-
-test("get 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();
-});
-
-test("get 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();
-});
-
-test("get and unset config option is successful", 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");
-});
-
-test("get and unset config option is successful 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");
-});
-
-test("get and unset config option is unsuccessful", async () => {
-  const repoPath = getRepoPath();
-  const getAndUnset = await getAndUnsetConfigOption(repoPath, "this.key.does.not.exist");
-  expect(getAndUnset).toBeNull();
-});

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/index.js

@@ -1,122 +0,0 @@
-const { inspect } = require("util");
-const isDocker = require("is-docker");
-const core = require("@actions/core");
-const exec = require("@actions/exec");
-const setupPython = require("./setup-python");
-const {
-  getRepoPath,
-  getAndUnsetConfigOption,
-  addConfigOption
-} = require("./git");
-
-const EXTRAHEADER_OPTION = "http.https://github.com/.extraheader";
-const EXTRAHEADER_VALUE_REGEX = "^AUTHORIZATION:";
-
-async function run() {
-  try {
-    // Allows ncc to find assets to be included in the distribution
-    const cpr = __dirname + "/cpr";
-    core.debug(`cpr: ${cpr}`);
-
-    // Determine how to access python and pip
-    const { pip, python } = (function() {
-      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"),
-      request_to_parent: 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.request_to_parent) process.env.CPR_REQUEST_TO_PARENT = inputs.request_to_parent;
-    if (inputs.base) process.env.CPR_BASE = inputs.base;
-    if (inputs.branchSuffix) process.env.CPR_BRANCH_SUFFIX = inputs.branchSuffix;
-
-    // Get the repository path
-    var repoPath = getRepoPath(inputs.path);
-    // Get the extraheader config option if it exists
-    var 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) {
-      if (
-        await addConfigOption(
-          repoPath,
-          EXTRAHEADER_OPTION,
-          extraHeaderOption.value
-        )
-      )
-        core.debug(`Restored config option '${EXTRAHEADER_OPTION}'`);
-    }
-  }
-}
-
-run();

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/setup-python.js

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

src/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"]
+}