@@ -22,7 +22,7 @@ This action is experimental and may not work well for some use cases.
2222Linux
2323``` yml
2424 - name : Create Pull Request
25- uses : peter-evans/create-pull-request@v1.3.0
25+ uses : peter-evans/create-pull-request@v1.3.1
2626 env :
2727 GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
2828` ` `
@@ -39,11 +39,16 @@ Multi platform - Linux, MacOS, Windows (beta)
3939
4040These variables are all optional. If not set, a default value will be used.
4141
42- - ` PULL_REQUEST_BRANCH` - The branch name. See **Branch naming** below for details.
43- - ` BRANCH_SUFFIX` - The branch suffix type. Valid values are `short-commit-hash` (default) and `timestamp`. See **Branch naming** below for details.
4442- ` COMMIT_MESSAGE` - The message to use when committing changes.
4543- ` PULL_REQUEST_TITLE` - The title of the pull request.
4644- ` PULL_REQUEST_BODY` - The body of the pull request.
45+ - ` PULL_REQUEST_LABELS` - A comma separated list of labels.
46+ - ` PULL_REQUEST_ASSIGNEES` - A comma separated list of assignees (GitHub usernames).
47+ - ` PULL_REQUEST_REVIEWERS` - A comma separated list of reviewers (GitHub usernames) to request a review from.
48+ - ` PULL_REQUEST_TEAM_REVIEWERS` - A comma separated list of GitHub teams to request a review from.
49+ - ` PULL_REQUEST_MILESTONE` - The number of the milestone to associate this pull request with.
50+ - ` PULL_REQUEST_BRANCH` - The branch name. See **Branch naming** below for details.
51+ - ` BRANCH_SUFFIX` - The branch suffix type. Valid values are `short-commit-hash` (default) and `timestamp`. See **Branch naming** below for details.
4752
4853The following parameters are available for debugging and troubleshooting.
4954
@@ -78,15 +83,30 @@ If there are files or directories you want to ignore you can simply add them to
7883Here is an example that sets all the main environment variables.
7984
8085```yml
86+ on:
87+ repository_dispatch:
88+ types: [create-pull-request]
89+ name: create-pull-request workflow
90+ jobs:
91+ createPullRequest:
92+ runs-on: ubuntu-latest
93+ steps:
94+ - uses: actions/checkout@v1
95+ - name: Create report file
96+ run: touch report.txt
8197 - name: Create Pull Request
82- uses: peter-evans/create-pull-request@v1.3.0
98+ uses: peter-evans/create-pull-request@v1.3.1
8399 env:
84100 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
85- PULL_REQUEST_BRANCH: my-patches
101+ COMMIT_MESSAGE: Add report file
102+ PULL_REQUEST_BODY: This PR is auto-generated by [create-pull-request](https://github.com/peter-evans/create-pull-request).
103+ PULL_REQUEST_TITLE: '[Example] New report'
104+ PULL_REQUEST_LABELS: report, automated pr
105+ PULL_REQUEST_ASSIGNEES: peter-evans
106+ PULL_REQUEST_REVIEWERS: peter-evans
107+ PULL_REQUEST_MILESTONE: 1
108+ PULL_REQUEST_BRANCH: example-patches
86109 BRANCH_SUFFIX: short-commit-hash
87- COMMIT_MESSAGE: Auto-modify files by my-file-modifier-action
88- PULL_REQUEST_TITLE: Changes from my-file-modifier-action
89- PULL_REQUEST_BODY: This is an auto-generated PR with changes from my-file-modifier-action
90110```
91111
92112This configuration will create pull requests that look like this:
0 commit comments