Merge pull request #101 from peter-evans/dev

Update title and body when pr exists

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

@@ -1,7 +1,7 @@
-name: Create Pull Request
+name: Create Pull Request Example Command
 on:
   repository_dispatch:
-    types: [create-pull-request]
+    types: [cpr-example-command]
 jobs:
   createPullRequest:
     runs-on: ubuntu-latest
@@ -34,3 +34,10 @@ jobs:
         run: |
           echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
           echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
+      - name: Add reaction
+        uses: peter-evans/create-or-update-comment@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          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/slash-command-dispatch.yml

@@ -11,6 +11,28 @@ jobs:
         with:
           token: ${{ secrets.REPO_ACCESS_TOKEN }}
           reaction-token: ${{ secrets.GITHUB_TOKEN }}
-          commands: test, pytest, clean
-          permission: admin
-          repository: peter-evans/create-pull-request-tests
+          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"
+              }
+            ]

README.md

@@ -33,15 +33,17 @@ Create Pull Request action will:
 
 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
+
+With the exception of `token`, 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: pull_request` workflow then you must use a [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) instead of the default `GITHUB_TOKEN`.
 See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) for further details.
 
-### Action inputs
-
-These inputs are *all optional*. If not set, sensible default values will be used.
-
 | 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). | |
+| `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. |

action.yml

@@ -2,8 +2,10 @@ name: 'Create Pull Request'
 description: 'Creates a pull request for changes to your repository in the actions workspace'
 inputs:
   token:
-    description: 'The GitHub authentication token'
+    description: 'GITHUB_TOKEN or a repo scoped PAT'
     required: true
+  path:
+    description: 'Relative path under $GITHUB_WORKSPACE to the repository.'
   commit-message:
     description: 'The message to use when committing changes.'
   committer:

dist/index.js

@@ -1012,7 +1012,7 @@ async function run() {
     core.debug(`src: ${src}`);
 
     // Setup Python from the tool cache
-    setupPython("3.8.0", "x64");
+    setupPython("3.8.x", "x64");
 
     // Install requirements
     await exec.exec("pip", [
@@ -1024,6 +1024,7 @@ async function run() {
     // 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"),
@@ -1044,6 +1045,7 @@ async function run() {
 
     // 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;

dist/src/create_or_update_pull_request.py

@@ -72,6 +72,8 @@ def create_or_update_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} ({branch} => {base})")
         else:
             print(str(e))

dist/src/create_pull_request.py

@@ -96,6 +96,7 @@ def set_committer_author(repo, committer, author):
 github_token = os.environ["GITHUB_TOKEN"]
 github_repository = os.environ["GITHUB_REPOSITORY"]
 # 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'
@@ -103,8 +104,8 @@ committer = os.environ.get("CPR_COMMITTER")
 author = os.environ.get("CPR_AUTHOR")
 base = os.environ.get("CPR_BASE")
 
-# Set the repo to the working directory
-repo = Repo(os.getcwd())
+# Set the repo path
+repo = Repo(path)
 
 # 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

docs/concepts-guidelines.md

@@ -9,6 +9,7 @@ This document covers terminology, how the action works, and general usage guidel
   - [Providing a consistent base](#providing-a-consistent-base)
   - [Pull request events](#pull-request-events)
   - [Restrictions on forked repositories](#restrictions-on-forked-repositories)
+  - [Tag push events](#tag-push-events)
 
 ## Terminology
 
@@ -30,7 +31,7 @@ The default can be overridden by specifying a `ref` on checkout.
 ```yml
       - uses: actions/checkout@v2
         with:
-          ref: master
+          ref: develop
 ```
 
 ## How the action works
@@ -105,3 +106,68 @@ jobs:
     # Check if the event is not triggered by a fork
     if: github.event.pull_request.head.repo.full_name == github.repository
 ```
+
+### Tag push events
+
+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}
+
+      - name: Create changes to pull request
+        run: <create changes here>
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          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
+
+      - name: Create changes to pull request
+        run: <create changes here>
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+```

docs/examples.md

@@ -1,8 +1,9 @@
 # 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)
 - [Use case: Create a pull request to update X periodically](#use-case-create-a-pull-request-to-update-x-periodically)
   - [Update NPM dependencies](#update-npm-dependencies)
-  - [Keep Go up to date](#keep-go-up-to-date)
   - [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)
@@ -16,6 +17,40 @@
   - [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:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: update authors
+          title: Update AUTHORS
+          body: Credit new contributors by updating AUTHORS
+          branch: update-authors
+```
+
 ## 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.
@@ -51,39 +86,6 @@ jobs:
           branch: dep-updates
 ```
 
-### Keep Go up to date
-
-Keep Go up to date with [ensure-latest-go](https://github.com/jmhodges/ensure-latest-go) action.
-
-```yml
-name: Keeping Go up to date
-on:
-  schedule:
-    - cron: 47 4 * * *
-  push:
-    branches:
-      - master
-jobs:
-  fresh_go:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: master
-      - uses: jmhodges/ensure-latest-go@v1.0.2
-        id: ensure_go
-      - run: echo "##[set-output name=pr_title;]update to latest Go release ${{ steps.ensure_go.outputs.go_version}}"
-        id: pr_title_maker
-      - name: Create pull request
-        uses: peter-evans/create-pull-request@v2
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          title: ${{ steps.pr_title_maker.outputs.pr_title }}
-          body: Auto-generated pull request created by the GitHub Actions [create-pull-request](https://github.com/peter-evans/create-pull-request) and [ensure-latest-go](https://github.com/jmhodges/ensure-latest-go).
-          commit-message: ${{ steps.pr_title_maker.outputs.pr_title }}
-          branch: ensure-latest-go/patch-${{ steps.ensure_go.outputs.go_version }}
-```
-
 ### 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).
@@ -225,7 +227,7 @@ An `on: repository_dispatch` workflow can be triggered from another workflow wit
 
 ## Use case: Create a pull request to modify/fix pull requests
 
-**Note**: While the following approach does work in some cases, 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.
+**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.
 
@@ -256,7 +258,7 @@ jobs:
           ref: ${{ github.head_ref }}
       - name: autopep8
         id: autopep8
-        uses: peter-evans/autopep8@v1.1.0
+        uses: peter-evans/autopep8@v1
         with:
           args: --exit-code --recursive --in-place --aggressive --aggressive .
       - name: Set autopep8 branch name

index.js

@@ -10,7 +10,7 @@ async function run() {
     core.debug(`src: ${src}`);
 
     // Setup Python from the tool cache
-    setupPython("3.8.0", "x64");
+    setupPython("3.8.x", "x64");
 
     // Install requirements
     await exec.exec("pip", [
@@ -22,6 +22,7 @@ async function run() {
     // 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"),
@@ -42,6 +43,7 @@ async function run() {
 
     // 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;

package-lock.json

@@ -36,9 +36,9 @@
       }
     },
     "@zeit/ncc": {
-      "version": "0.20.5",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.20.5.tgz",
-      "integrity": "sha512-XU6uzwvv95DqxciQx+aOLhbyBx/13ky+RK1y88Age9Du3BlA4mMPCy13BGjayOrrumOzlq1XV3SD/BWiZENXlw==",
+      "version": "0.21.0",
+      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.21.0.tgz",
+      "integrity": "sha512-RUMdvVK/w78oo+yBjruZltt0kJXYar2un/1bYQ2LuHG7GmFVm+QjxzEmySwREctaJdEnBvlMdUNWd9hXHxEI3g==",
       "dev": true
     },
     "qs": {

package.json

@@ -23,6 +23,6 @@
     "@actions/tool-cache": "^1.1.2"
   },
   "devDependencies": {
-    "@zeit/ncc": "0.20.5"
+    "@zeit/ncc": "0.21.0"
   }
 }

src/create_or_update_pull_request.py

@@ -72,6 +72,8 @@ def create_or_update_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} ({branch} => {base})")
         else:
             print(str(e))

src/create_pull_request.py

@@ -96,6 +96,7 @@ def set_committer_author(repo, committer, author):
 github_token = os.environ["GITHUB_TOKEN"]
 github_repository = os.environ["GITHUB_REPOSITORY"]
 # 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'
@@ -103,8 +104,8 @@ committer = os.environ.get("CPR_COMMITTER")
 author = os.environ.get("CPR_AUTHOR")
 base = os.environ.get("CPR_BASE")
 
-# Set the repo to the working directory
-repo = Repo(os.getcwd())
+# Set the repo path
+repo = Repo(path)
 
 # 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