diff --git a/.github/workflows/create-pull-request-multi.yml b/.github/workflows/create-pull-request-multi.yml
index 19f62cd..855a15b 100644
--- a/.github/workflows/create-pull-request-multi.yml
+++ b/.github/workflows/create-pull-request-multi.yml
@@ -38,8 +38,4 @@ jobs:
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%
+ run: echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
diff --git a/.github/workflows/create-pull-request.yml b/.github/workflows/create-pull-request.yml
index 89b41bd..b8da333 100644
--- a/.github/workflows/create-pull-request.yml
+++ b/.github/workflows/create-pull-request.yml
@@ -30,4 +30,4 @@ jobs:
PULL_REQUEST_BRANCH: example-patches
BRANCH_SUFFIX: short-commit-hash
- name: Check output environment variable
- run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"
+ run: echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
diff --git a/README.md b/README.md
index e9a31fb..0291fc2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# 
Create Pull Request
+# 
Create Pull Request
[](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.
@@ -15,10 +15,12 @@ Create Pull Request action will:
## Usage
+See [examples](examples.md) for detailed use cases.
+
Linux
```yml
- name: Create Pull Request
- uses: peter-evans/create-pull-request@v1.5.4
+ uses: peter-evans/create-pull-request@v1.6.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
@@ -26,12 +28,12 @@ Linux
Multi platform - Linux, MacOS, Windows (beta)
```yml
- name: Create Pull Request
- uses: peter-evans/create-pull-request@v1.5.4-multi
+ uses: peter-evans/create-pull-request@v1.6.0-multi
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
-**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 instead of the default `GITHUB_TOKEN`.
+**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.
### Environment variables
@@ -60,10 +62,9 @@ These variables are *all optional*. If not set, sensible default values will be
**Debug environment variables**
-The following parameters are available for debugging and troubleshooting.
+The following parameter is available for debugging and troubleshooting.
- `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow.
-- `SKIP_IGNORE` - If present, the `ignore_event` function will be skipped.
### Branch naming
@@ -88,15 +89,15 @@ To use this strategy, set `BRANCH_SUFFIX` to the value `none`. The variable `PUL
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.
-## Examples
+## Reference Example
-Here is an example that sets all the main environment variables.
+The following workflow is a reference example that sets all the main environment variables.
+
+See [examples](examples.md) for more realistic use cases.
```yml
-name: create-pull-request workflow
-on:
- repository_dispatch:
- types: [create-pull-request]
+name: Create Pull Request
+on: push
jobs:
createPullRequest:
runs-on: ubuntu-latest
@@ -105,7 +106,7 @@ jobs:
- name: Create report file
run: date +%s > report.txt
- name: Create Pull Request
- uses: peter-evans/create-pull-request@v1.5.4
+ uses: peter-evans/create-pull-request@v1.6.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COMMIT_MESSAGE: Add report file
@@ -125,133 +126,12 @@ jobs:
PULL_REQUEST_BRANCH: example-patches
BRANCH_SUFFIX: short-commit-hash
- name: Check output environment variable
- run: echo "Pull Request Number - $PULL_REQUEST_NUMBER"
+ run: echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
```
-This configuration will create pull requests that look like this:
+This reference configuration will create pull requests that look like this:
-
-
-
-### Example workflow to automate periodic dependency updates
-
-This example workflow executes once a week and will create a pull request for any dependency updates. This pattern will work well for updating any kind of static content from an external source.
-
-```yml
-name: Update Dependencies
-on:
- schedule:
- - cron: '0 10 * * 1'
-jobs:
- update-deps:
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v1
- - uses: actions/setup-node@v1
- with:
- node-version: '10.x'
- - name: Update dependencies
- id: vars
- run: |
- npm install -g npm-check-updates
- ncu -u
- npm install
- - name: Create Pull Request
- uses: peter-evans/create-pull-request@v1.5.4
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- COMMIT_MESSAGE: update dependencies
- COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
- COMMIT_AUTHOR_NAME: Peter Evans
- PULL_REQUEST_TITLE: Automated Dependency Updates
- PULL_REQUEST_BODY: This is an auto-generated PR with dependency updates.
- PULL_REQUEST_LABELS: dep-updates, automated pr
- PULL_REQUEST_REVIEWERS: peter-evans
- PULL_REQUEST_BRANCH: dep-updates
- BRANCH_SUFFIX: none
-```
-
-### Example usage with "on: pull_request" workflows
-
-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. This is a pattern that would work well for any automated code linting and fixing.
-
-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:
- if: startsWith(github.head_ref, 'autopep8-patches') == false
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v1
- - name: autopep8
- id: autopep8
- uses: peter-evans/autopep8@v1.1.0
- with:
- args: --exit-code --recursive --in-place --aggressive --aggressive .
- - name: Set autopep8 branch name
- id: vars
- run: echo ::set-output name=branch-name::"autopep8-patches/$GITHUB_HEAD_REF"
- - name: Create Pull Request
- if: steps.autopep8.outputs.exit-code == 2
- uses: peter-evans/create-pull-request@v1.5.4
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- COMMIT_MESSAGE: autopep8 action fixes
- COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com
- COMMIT_AUTHOR_NAME: Peter Evans
- PULL_REQUEST_TITLE: Fixes by autopep8 action
- PULL_REQUEST_BODY: This is an auto-generated PR with fixes by autopep8.
- PULL_REQUEST_LABELS: autopep8, automated pr
- PULL_REQUEST_REVIEWERS: peter-evans
- PULL_REQUEST_BRANCH: ${{ steps.vars.outputs.branch-name }}
- BRANCH_SUFFIX: none
- - name: Fail if autopep8 made changes
- if: steps.autopep8.outputs.exit-code == 2
- run: exit 1
-```
-
-### 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`. Note that the step where output variables are defined must have an id.
-
-```yml
- - name: Set output variables
- id: vars
- run: |
- echo ::set-output name=pr_title::"[Test] Add report file $(date +%d-%m-%Y)"
- echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \
- by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
- - name: Create Pull Request
- uses: peter-evans/create-pull-request@v1.5.4
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- PULL_REQUEST_TITLE: ${{ steps.vars.outputs.pr_title }}
- PULL_REQUEST_BODY: ${{ steps.vars.outputs.pr_body }}
-```
-
-Since the action reads environment variables from the system, it's technically not necessary to explicitly pass them as long as they exist in the environment. So the following method using `set-env` *also* works, but explicitly passing the configuration parameters using the previous method is perferred for its clarity.
-
-```yml
- - name: Set environment variables
- run: |
- echo ::set-env name=PULL_REQUEST_TITLE::"[Test] Add report file $(date +%d-%m-%Y)"
- echo ::set-env name=PULL_REQUEST_BODY::"This PR was auto-generated on $(date +%d-%m-%Y) \
- by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
- - name: Create Pull Request
- uses: peter-evans/create-pull-request@v1.5.4
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
+
## License
diff --git a/logo.svg b/assets/logo.svg
similarity index 100%
rename from logo.svg
rename to assets/logo.svg
diff --git a/pull-request-example.png b/assets/pull-request-example.png
similarity index 100%
rename from pull-request-example.png
rename to assets/pull-request-example.png
diff --git a/create-pull-request.py b/create-pull-request.py
index f33b967..93f1b5c 100755
--- a/create-pull-request.py
+++ b/create-pull-request.py
@@ -8,6 +8,7 @@ import sys
import time
from git import Repo
from github import Github
+from github import GithubException
def get_github_event(github_event_path):
@@ -81,7 +82,7 @@ def cs_string_to_list(str):
return list(filter(None, l))
-def process_event(github_token, github_repository, repo, branch, base, remote_exists):
+def process_event(github_token, github_repository, repo, branch, base):
# Fetch optional environment variables with default values
commit_message = os.getenv(
'COMMIT_MESSAGE',
@@ -104,21 +105,29 @@ def process_event(github_token, github_repository, repo, branch, base, remote_ex
push_result = push_changes(repo.git, branch, commit_message)
print(push_result)
- # If the remote existed then we are using fixed branch strategy.
- # A PR should already exist 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)
+ try:
+ pull_request = github_repo.create_pull(
+ title=title,
+ body=body,
+ base=base,
+ head=branch)
+ print("Created pull request #%d (%s => %s)" %
+ (pull_request.number, branch, base))
+ except GithubException as e:
+ if e.status == 422:
+ pull_request = github_repo.get_pulls(
+ state='open',
+ base=base,
+ head=branch)[1]
+ print("Updated pull request #%d (%s => %s)" %
+ (pull_request.number, branch, base))
+ else:
+ print(str(e))
+ sys.exit(1)
+
+ # Set the output variable
os.system(
'echo ::set-env name=PULL_REQUEST_NUMBER::%d' %
pull_request.number)
@@ -135,11 +144,18 @@ def process_event(github_token, github_repository, repo, branch, base, remote_ex
milestone = github_repo.get_milestone(int(pull_request_milestone))
pull_request.as_issue().edit(milestone=milestone)
- # Set pull request reviewers and team reviewers
+ # Set pull request reviewers
if pull_request_reviewers is not None:
print("Requesting reviewers")
- pull_request.create_review_request(
- reviewers=cs_string_to_list(pull_request_reviewers))
+ try:
+ pull_request.create_review_request(
+ reviewers=cs_string_to_list(pull_request_reviewers))
+ except GithubException as e:
+ # Likely caused by "Review cannot be requested from pull request author."
+ if e.status == 422:
+ print("Requesting reviewers failed - %s" % e.data["message"])
+
+ # Set pull request team reviewers
if pull_request_team_reviewers is not None:
print("Requesting team reviewers")
pull_request.create_review_request(
@@ -238,7 +254,6 @@ if repo.is_dirty() or len(repo.untracked_files) > 0:
github_repository,
repo,
branch,
- base,
- remote_exists)
+ base)
else:
print("Repository has no modified or untracked files. Skipping.")
diff --git a/examples.md b/examples.md
new file mode 100644
index 0000000..2843e4c
--- /dev/null
+++ b/examples.md
@@ -0,0 +1,219 @@
+# Examples
+
+- [Use case: Create a pull request to update X periodically](#use-case-create-a-pull-request-to-update-x-periodically)
+ - [Update NPM dependencies](#update-npm-dependencies)
+ - [Keep Go up to date](#keep-go-up-to-date)
+ - [Spider and download a website](#spider-and-download-a-website)
+- [Use case: Create a pull request to 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)
+
+
+## Use case: Create a pull request to update X periodically
+
+This pattern will work well for updating any kind of static content from an external source. The workflow executes on a schedule and raises a pull request when there are changes.
+
+### Update NPM dependencies
+
+```yml
+name: Update Dependencies
+on:
+ schedule:
+ - cron: '0 10 * * 1'
+jobs:
+ update-deps:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v1
+ - uses: actions/setup-node@v1
+ with:
+ node-version: '10.x'
+ - name: Update dependencies
+ id: vars
+ run: |
+ npm install -g npm-check-updates
+ ncu -u
+ npm install
+ - name: Create Pull Request
+ uses: peter-evans/create-pull-request@v1.6.0
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ COMMIT_MESSAGE: update dependencies
+ PULL_REQUEST_TITLE: Automated Dependency Updates
+ PULL_REQUEST_BODY: This is an auto-generated PR with dependency updates.
+ PULL_REQUEST_BRANCH: dep-updates
+ BRANCH_SUFFIX: none
+```
+
+### Keep Go up to date
+
+Keep Go up to date with [ensure-latest-go](https://github.com/jmhodges/ensure-latest-go) action.
+
+```yml
+name: Keeping Go up to date
+on:
+ schedule:
+ - cron: 47 4 * * *
+ push:
+ branches:
+ - master
+jobs:
+ fresh_go:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v1
+ with:
+ ref: master
+ - uses: jmhodges/ensure-latest-go@v1.0.2
+ id: ensure_go
+ - run: echo "##[set-output name=pr_title;]update to latest Go release ${{ steps.ensure_go.outputs.go_version}}"
+ id: pr_title_maker
+ - name: Create pull request
+ uses: peter-evans/create-pull-request@v1.6.0
+ env:
+ PULL_REQUEST_TITLE: ${{ steps.pr_title_maker.outputs.pr_title }}
+ PULL_REQUEST_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 }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ BRANCH_SUFFIX: none
+ PULL_REQUEST_BRANCH: ensure-latest-go/patch-${{ steps.ensure_go.outputs.go_version }}
+```
+
+### Spider and download a website
+
+```yml
+name: Download Website
+on:
+ schedule:
+ - cron: '0 10 * * *'
+jobs:
+ format:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v1
+ - name: Download website
+ run: |
+ wget \
+ --recursive \
+ --level=2 \
+ --wait=1 \
+ --no-clobber \
+ --page-requisites \
+ --html-extension \
+ --convert-links \
+ --domains quotes.toscrape.com \
+ http://quotes.toscrape.com/
+ - name: Create Pull Request
+ uses: peter-evans/create-pull-request@v1.6.0
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ COMMIT_MESSAGE: update local website copy
+ PULL_REQUEST_TITLE: Automated Updates to Local Website Copy
+ PULL_REQUEST_BODY: This is an auto-generated PR with website updates.
+ PULL_REQUEST_BRANCH: website-updates
+ BRANCH_SUFFIX: none
+```
+
+## Use case: Create a pull request to modify/fix pull requests
+
+This is a pattern that works well for any automated code linting and fixing. A pull request can be created to fix or modify something during an `on: pull_request` workflow. The pull request containing the fix will be raised with the original pull request as the base. This can be then be merged to update the original pull request and pass any required tests.
+
+### 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:
+ if: startsWith(github.head_ref, 'autopep8-patches') == false
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v1
+ - name: autopep8
+ id: autopep8
+ uses: peter-evans/autopep8@v1.1.0
+ with:
+ args: --exit-code --recursive --in-place --aggressive --aggressive .
+ - name: Set autopep8 branch name
+ id: vars
+ run: echo ::set-output name=branch-name::"autopep8-patches/$GITHUB_HEAD_REF"
+ - name: Create Pull Request
+ if: steps.autopep8.outputs.exit-code == 2
+ uses: peter-evans/create-pull-request@v1.6.0
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ COMMIT_MESSAGE: autopep8 action fixes
+ PULL_REQUEST_TITLE: Fixes by autopep8 action
+ PULL_REQUEST_BODY: This is an auto-generated PR with fixes by autopep8.
+ PULL_REQUEST_LABELS: autopep8, automated pr
+ PULL_REQUEST_BRANCH: ${{ steps.vars.outputs.branch-name }}
+ BRANCH_SUFFIX: none
+ - name: Fail if autopep8 made changes
+ if: steps.autopep8.outputs.exit-code == 2
+ run: exit 1
+```
+
+## Misc workflow tips
+
+### Filtering push events
+
+For workflows using `on: push` you may want to ignore push events for tags and remotes.
+These can be filtered out with the following `if` condition.
+
+```yml
+name: Create Pull Request
+on: push
+jobs:
+ createPullRequest:
+ if: startsWith(github.ref, 'refs/heads/')
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v1
+ ...
+```
+
+### Dynamic configuration using variables
+
+The following examples show how configuration for the action can be dynamically defined in a previous workflow step.
+
+The recommended method is to use [`set-output`](https://help.github.com/en/github/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-an-output-parameter-set-output). Note that the step where output variables are defined must have an id.
+
+```yml
+ - name: Set output variables
+ id: vars
+ run: |
+ echo ::set-output name=pr_title::"[Test] Add report file $(date +%d-%m-%Y)"
+ echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \
+ by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
+ - name: Create Pull Request
+ uses: peter-evans/create-pull-request@v1.6.0
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ PULL_REQUEST_TITLE: ${{ steps.vars.outputs.pr_title }}
+ PULL_REQUEST_BODY: ${{ steps.vars.outputs.pr_body }}
+```
+
+Since the action reads environment variables from the system, it's technically not necessary to explicitly pass them as long as they exist in the environment. So the following method using `set-env` *also* works, but explicitly passing the configuration parameters using the previous method is perferred for its clarity.
+
+```yml
+ - name: Set environment variables
+ run: |
+ echo ::set-env name=PULL_REQUEST_TITLE::"[Test] Add report file $(date +%d-%m-%Y)"
+ echo ::set-env name=PULL_REQUEST_BODY::"This PR was auto-generated on $(date +%d-%m-%Y) \
+ by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
+ - name: Create Pull Request
+ uses: peter-evans/create-pull-request@v1.6.0
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```