Skip to content

Commit 173ff2a

Browse files
authored
docs: add documentation about caveats of using GITHUB_TOKEN (#557)
* docs: add documentation about caveats of using `GITHUB_TOKEN` Signed-off-by: Jeff Ching <chingor@google.com> * fix typo Signed-off-by: Jeff Ching <chingor@google.com> Signed-off-by: Jeff Ching <chingor@google.com>
1 parent 4488971 commit 173ff2a

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,20 @@ Automate releases with Conventional Commit Messages.
8888
| `release-search-depth` | when searching for the latest release SHAs, only consider the last N releases |
8989
| `commit-search-depth` | when fetching the list of commits to consider, only consider the last N commits |
9090

91+
## GitHub credentials
92+
93+
`release-please` requires a GitHub token to access the GitHub API. You configure this token via the
94+
`token` configuration option. You can use the built-in `GITHUB_TOKEN` secret, however, note that any resources
95+
created by `release-please` (release tag or release pull request) will not trigger future GitHub actions
96+
workflows.
97+
98+
From the [docs](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow):
99+
> When you use the repository's `GITHUB_TOKEN` to perform tasks, events triggered by the `GITHUB_TOKEN` will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs.
100+
101+
This means that GitHub actions CI checks will not run on the release pull request and workflows normally triggered by
102+
`release.created` events will also not run. You will want to configure a GitHub actions secret with a
103+
[personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
104+
if you want other workflows to run.
91105

92106
### The `command` option
93107
Some additional info regarding the `command` property.

0 commit comments

Comments
 (0)