Skip to content

Commit ab19e81

Browse files
committed
update-project-version: Clarify docs about PR status checks
1 parent 0e364bd commit ab19e81

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,9 @@ desired release version before creating a release in GitHub.
256256

257257
#### `token`
258258

259-
The default GITHUB_TOKEN cannot trigger PR workflows. You can work around this by using `token` to
260-
specify a token that is saved in a repo/org secret.
259+
The default GITHUB_TOKEN cannot trigger PR workflows, so the generated pull request will not run any
260+
status checks. You can work around this by using `token` to specify a token that is saved in a
261+
repo/org secret.
261262

262263
See [Triggering further workflow
263264
runs](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs)

update-project-version/action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ inputs:
1515
token:
1616
description: >
1717
GitHub token to use to create the pull request. The default GITHUB_TOKEN
18-
cannot trigger PR workflows, so you can use this to specify a PAT that is
19-
saved in a repo/org secret.
18+
cannot trigger PR workflows (i.e., it will not run PR status checks). You
19+
can use this input to specify a PAT that is saved in a repo/org secret.
2020
default: ${{ github.token }}
2121
version-rule:
2222
description: >

0 commit comments

Comments
 (0)