Skip to content

Commit 31be506

Browse files
committed
doc: document how to apply a token with github-nodejs-bot
1 parent f13df50 commit 31be506

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

APPLY_ACCESS_TOKEN.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Apply for a nodejs-github-bot token
2+
3+
Automation in https://github.com/nodejs may require github access token to access
4+
permission scoped endpoints. In the case of such requirement, the access token can
5+
be requested to be created under the name of https://github.com/nodejs-github-bot.
6+
7+
Only fine-grained access token can be created under the name of https://github.com/nodejs-github-bot.
8+
9+
To create a fine-grained access token with nodejs-github-bot, submit a PR to
10+
add the requested repo in the registry below, and a TSC member or a build WG member
11+
(who has access to the https://github.com/nodejs-github-bot account) need to take
12+
action to create the fine-grained token and save the token to the requested repo's
13+
repository secrets.
14+
15+
Fine-grained tokens created with access to https://github.com/nodejs resources will
16+
be audited at https://github.com/organizations/nodejs/settings/personal-access-tokens/active.
17+
18+
## Registry
19+
20+
The "repo" is a string of the GitHub `<owner>/<repo>`. Generally, the token should
21+
only be created for repo in the https://github.com/nodejs organization.
22+
23+
The "token name" is a string that the token can be referenced in the GitHub Action
24+
scripts. Like a token name of `RELEASE_PLEASE_TOKEN` can be accessed from the script
25+
as `${{ secrets.RELEASE_PLEASE_TOKEN }}`.
26+
27+
Repo | Token name
28+
--- | ---
29+
nodejs/import-in-the-middle | RELEASE_PLEASE_GITHUB_TOKEN

0 commit comments

Comments
 (0)