Skip to content

Commit

Permalink
doc: document how to apply a token with github-nodejs-bot
Browse files Browse the repository at this point in the history
  • Loading branch information
legendecas committed Jul 16, 2024
1 parent f13df50 commit 31be506
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions APPLY_ACCESS_TOKEN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Apply for a nodejs-github-bot token

Automation in https://github.com/nodejs may require github access token to access
permission scoped endpoints. In the case of such requirement, the access token can
be requested to be created under the name of https://github.com/nodejs-github-bot.

Only fine-grained access token can be created under the name of https://github.com/nodejs-github-bot.

To create a fine-grained access token with nodejs-github-bot, submit a PR to
add the requested repo in the registry below, and a TSC member or a build WG member
(who has access to the https://github.com/nodejs-github-bot account) need to take
action to create the fine-grained token and save the token to the requested repo's
repository secrets.

Fine-grained tokens created with access to https://github.com/nodejs resources will
be audited at https://github.com/organizations/nodejs/settings/personal-access-tokens/active.

## Registry

The "repo" is a string of the GitHub `<owner>/<repo>`. Generally, the token should
only be created for repo in the https://github.com/nodejs organization.

The "token name" is a string that the token can be referenced in the GitHub Action
scripts. Like a token name of `RELEASE_PLEASE_TOKEN` can be accessed from the script
as `${{ secrets.RELEASE_PLEASE_TOKEN }}`.

Repo | Token name
--- | ---
nodejs/import-in-the-middle | RELEASE_PLEASE_GITHUB_TOKEN

0 comments on commit 31be506

Please sign in to comment.