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
{{ message }}
This repository was archived by the owner on Aug 15, 2024. It is now read-only.
docs: emphasize the need for a personal access token (#842)
It isn't made explicit that the default token is one that doesn't allow
GitHub Actions CI jobs to run.
Updated the section to make that even more clear.
Signed-off-by: Leland Clemmons <[email protected]>
Co-authored-by: Jeff Ching <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+18-10Lines changed: 18 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -98,20 +98,28 @@ Automate releases with Conventional Commit Messages.
98
98
99
99
## GitHub credentials
100
100
101
-
`release-please`requires a GitHub token to access the GitHub API. You configure this token via the
102
-
`token`configuration option. You can use the built-in `GITHUB_TOKEN` secret, however, note that any resources
103
-
created by `release-please` (release tag or release pull request) will not trigger future GitHub actions
104
-
workflows.
101
+
`release-please`requires a GitHub token to access the GitHub API. You configure this token via
102
+
the `token` configuration option.
103
+
104
+
> [!WARNING]
105
+
> If using GitHub Actions, you will need to specify a `token` for your workflows to run on
106
+
> Release Please's releases and PRs.
105
107
106
-
From the [docs](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow):
107
-
> 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.
108
+
By default, Release Please uses the built-in `GITHUB_TOKEN` secret. However, all resources created
109
+
by `release-please` (release tag or release pull request) will not trigger future GitHub actions workflows,
110
+
and workflows normally triggered by `release.created` events will also not run.
if you want GitHub Actions CI checks to run on Release Please PRs.
113
120
114
121
### The `command` option
122
+
115
123
Some additional info regarding the `command` property.
116
124
- `github-release`: creates GitHub releases (as mentioned [here](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)) based on the most recently merged release PR and the release strategy being used.
117
125
- `release-pr`: uses Conventional Commits to propose a candidate release [pull request](#how-release-please-works). This pull request, once merged, is used by `github-release`/`manifest`
0 commit comments