@@ -27,14 +27,30 @@ steps as:
2727Fine-grained tokens created with access to https://github.com/nodejs resources will
2828be audited at https://github.com/organizations/nodejs/settings/personal-access-tokens/active .
2929
30+ ## When to use a nodejs-github-bot token
31+
32+ By default, GitHub built-in token for an action workflow ` secrets.GITHUB_TOKEN ` does not
33+ trigger recursive workflow runs. If a workflow requires an exceptional case to trigger
34+ recursive workflow runs, or cross-repository workflows, file a PR as documented above.
35+
36+ GitHub also introduced ` approval-required ` state, which allows manual approving workflow
37+ to run on automated PRs. It is recommended to use GitHub action permission control to
38+ improve workflow securities.
39+
40+ The commonly known cases are as follows:
41+
42+ - Cross repo deployment: request a nodejs-github-bot token.
43+ - Release Please: use ` approval-required ` state instead.
44+ - Updating a dependency: use ` approval-required ` state instead.
45+
3046## Registry
3147
3248The "repo" is a string of the GitHub ` <owner>/<repo> ` . Generally, the token should
3349only be created for repo in the https://github.com/nodejs organization.
3450
3551The "secret name" is a string that the secret can be referenced in the GitHub Action
36- scripts. Like a secret name of ` RELEASE_PLEASE_TOKEN ` can be accessed from the script
37- as ` ${{ secrets.RELEASE_PLEASE_TOKEN }} ` .
52+ scripts. Like a secret name of ` DEPLOY_TOKEN ` can be accessed from the script
53+ as ` ${{ secrets.DEPLOY_TOKEN }} ` .
3854
3955The "expiration date" is the date before which the token should be renewed and
4056replaced. This should be no longer than 1 year.
0 commit comments