You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
* feat: restore working base branch and uncommitted changes* docs: uncommitted changes are stashed and restored* docs: add major version notes* fix: update package version* fix: update package-lock* feat: revise proxy implementation* docs: add notes for the revised proxy implementation* feat: set and remove git safe directory* docs: add notes for the git safe directory feature* fix: use base url for proxy check* feat: determine the git dir with rev-parse* build: update package lock* fix: remove support for ghes alpha* feat: revise handling of team reviewers* docs: update notes* feat: body-path* docs: update to v5* docs: update to v5* build: fix package lock
You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format`@v4.x.x`
37
+
You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format`@v5.x.x`
38
38
39
39
### Workflow permissions
40
40
@@ -65,17 +65,18 @@ All inputs are **optional**. If not set, sensible defaults will be used.
65
65
| `push-to-fork` | A fork of the checked-out parent repository to which the pull request branch will be pushed. e.g. `owner/repo-fork`. The pull request will be created to merge the fork's branch into the parent's base. See [push pull request branches to a fork](docs/concepts-guidelines.md#push-pull-request-branches-to-a-fork) for details. | |
66
66
| `title` | The title of the pull request. | `Changes by create-pull-request action` |
67
67
| `body` | The body of the pull request. | `Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action` |
68
+
| `body-path` | The path to a file containing the pull request body. Takes precedence over `body`. | |
68
69
| `labels` | A comma or newline-separated list of labels. | |
69
70
| `assignees` | A comma or newline-separated list of assignees (GitHub usernames). | |
70
71
| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | |
71
-
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). If using a GitHub App, refer to [Authenticating withGitHub Appgenerated tokens](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) for the proper permissions. | |
72
+
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token), or equivalent [GitHub Apppermissions](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens), are required. | |
72
73
| `milestone` | The number of the milestone to associate this pull request with. | |
73
74
| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). It is not possible to change draft status after creation except through the web interface. | `false` |
74
75
75
76
For self-hosted runners behind a corporate proxy set the `https_proxy` environment variable.
76
77
```yml
77
78
- name: Create Pull Request
78
-
uses: peter-evans/create-pull-request@v4
79
+
uses: peter-evans/create-pull-request@v5
79
80
env:
80
81
https_proxy: http://<proxy_address>:<port>
81
82
```
@@ -95,7 +96,7 @@ Note that in order to read the step outputs the action step must have an id.
95
96
```yml
96
97
- name: Create Pull Request
97
98
id: cpr
98
-
uses: peter-evans/create-pull-request@v4
99
+
uses: peter-evans/create-pull-request@v5
99
100
- name: Check outputs
100
101
if: ${{ steps.cpr.outputs.pull-request-number }}
101
102
run: |
@@ -154,11 +155,11 @@ If there are files or directories you want to ignore you can simply add them to
154
155
155
156
You can control which files are committed with the `add-paths` input.
156
157
Paths should follow git's [pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) syntax.
157
-
All filechanges that do not match one of the paths will bediscarded.
158
+
Filechanges that do not match one of the paths will bestashed and restored after the action has completed.
158
159
159
160
```yml
160
161
- name: Create Pull Request
161
-
uses: peter-evans/create-pull-request@v4
162
+
uses: peter-evans/create-pull-request@v5
162
163
with:
163
164
add-paths: |
164
165
*.java
@@ -185,7 +186,7 @@ Note that the repository must be checked out on a branch with a remote, it won't
185
186
- name: Uncommitted change
186
187
run: date +%s > report.txt
187
188
- name: Create Pull Request
188
-
uses: peter-evans/create-pull-request@v4
189
+
uses: peter-evans/create-pull-request@v5
189
190
```
190
191
191
192
### Create a project card
@@ -195,7 +196,7 @@ To create a project card for the pull request, pass the `pull-request-number` st