actions/gitea-release-please-action
1
0
Fork 0
mirror of https://github.com/joaquinjsb/gitea-release-please-action synced 2026-05-05 02:27:48 +02:00
Code Activity

docs: add documentation about caveats of using GITHUB_TOKEN (#557)

Browse Source 
* 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>
This commit is contained in:
Jeff Ching
2022-08-16 09:25:47 -07:00
committed by GitHub
parent 448897126a
commit 173ff2ae09
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -88,6 +88,20 @@ Automate releases with Conventional Commit Messages.
| `release-search-depth` | when searching for the latest release SHAs, only consider the last N releases |
| `commit-search-depth` | when fetching the list of commits to consider, only consider the last N commits |
## GitHub credentials
`release-please` requires a GitHub token to access the GitHub API. You configure this token via the
`token` configuration option. You can use the built-in `GITHUB_TOKEN` secret, however, note that any resources
created by `release-please` (release tag or release pull request) will not trigger future GitHub actions
workflows.
From the [docs](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow):
> 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.
This means that GitHub actions CI checks will not run on the release pull request and workflows normally triggered by
`release.created` events will also not run. You will want to configure a GitHub actions secret with a
[personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
if you want other workflows to run.
### The `command` option
Some additional info regarding the `command` property.