@@ -11,7 +11,8 @@ CLI tools for Node.js Core collaborators.
1111- [ Tools] ( #tools )
1212- [ Usage] ( #usage )
1313 - [ Install] ( #install )
14- - [ Setting up credentials] ( #setting-up-credentials )
14+ - [ Setting up GitHub credentials] ( #setting-up-github-credentials )
15+ - [ Setting up Jenkins credentials] ( #setting-up-jenkins-credentials )
1516 - [ Make sure your credentials won't be committed] ( #make-sure-your-credentials-wont-be-committed )
1617 - [ Troubleshooting] ( #troubleshooting )
1718- [ Contributing] ( #contributing )
@@ -49,7 +50,7 @@ npm install
4950npm link
5051```
5152
52- ### Setting up credentials
53+ ### Setting up GitHub credentials
5354
5455Most of the tools need your GitHub credentials to work. You can either
5556
@@ -83,6 +84,33 @@ After the token is generated, create an rc file with the following content:
8384Note: you could use ` ncu-config ` to configure these variables, but it's not
8485recommended to leave your tokens in your command line history.
8586
87+ ### Setting up Jenkins credentials
88+
89+ The ` git-node ` and ` ncu-ci ` commands need to query the Node.js Jenkins API for
90+ CI results, so you'll need to configure the Jenkins API token before using
91+ these commands.
92+
93+ To obtain the Jenkins API token
94+
95+ 1 . Open
96+ ` https://ci.nodejs.org/user/<your-github-id>/configure ` (replace
97+ \< your-github-id\> with your own GitHub ID)
98+ 2 . Click on the ` ADD NEW TOKEN ` button in the ` API Token ` section.
99+ 3 . Enter an identifiable name (for example, ` node-core-utils ` ) for this
100+ token in the inbox that appears, and click ` GENERATE ` .
101+ 4 . Copy the generated token.
102+ 5 . Add it into your ` ncurc ` file (` ~/.ncurc ` or ` $XDG_CONFIG_HOME/ncurc ` )
103+ with ` jenkins_token ` as key, like this
104+
105+ ``` json
106+ {
107+ "username" : " your_github_username" ,
108+ "token" : " your_github_token" ,
109+ "jenkins_token" : " your_jenkins_token"
110+ }
111+ ```
112+
113+
86114### Make sure your credentials won't be committed
87115
88116Put the following entries into ` ~/.gitignore_global `
0 commit comments