When creating the token, the following boxes need to be checked:
user:email: Used by git-node to read the email of the PR author in order
to check if it matches the email of the commit author.
read:org: Used by ncu-team to read the list of team members.
Optionally, if you want to grant write access so git-node can write comments:
public_repo (or repo if you intend to work with private repositories).
You can also edit the permission of existing tokens later.
After the token is generated, you can give it to NCU using:
With encryption (Recommended)
ncu-config set username your_github_username# Do not provide the token in the CLI, `ncu-config` will prompt you for it.ncu-config set -x token
Note: Encryption is available only if you have gpg setup on your machine.
Without encryption
ncu-config set username your_github_username# Do not provide the token in the CLI, `ncu-config` will prompt you for it.ncu-config set token
Setting up Jenkins credentials
The git-node and ncu-ci commands need to query the Node.js Jenkins API for
CI results, so you'll need to configure the Jenkins API token before using
these commands.
To obtain the Jenkins API token
Open
https://ci.nodejs.org/user/<your-github-username>/security (replace
<your-github-username> with your own GitHub username).
Click on the ADD NEW TOKEN button in the API Token section.
Enter an identifiable name (for example, node-core-utils) for this
token in the inbox that appears, and click GENERATE.
Copy the generated token.
Add it into your ncurc file (~/.ncurc or $XDG_CONFIG_HOME/ncurc, or
~/.ncurc.gpg or $XDG_CONFIG_HOME/ncurc.gpg) with jenkins_token as key,
like this:
With encryption (recommended)
ncu-config set -x jenkins_token
Note: Encryption is available only if you have gpg setup on your machine.
Without encryption
ncu-config set jenkins_token
Protecting your credentials
Put the following entries into your
global gitignore file
($XDG_CONFIG_HOME/git/ignore or a file specified by core.excludesFile). For example: