Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Writing good commit logs is important. A commit log should describe what
changed and why. Follow these guidelines when writing one:

1. The first line should be a short description of the change
(e.g. "get-metadata: check if the committer matches the author").
(e.g. "get-metadata: check if the committer matches the author").
2. Keep the second line blank.
3. Wrap all lines at 72 columns.

Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ npm link
Most of the tools need your GitHub credentials to work. You can either

1. Run any of the tools and you will be asked in a prompt to provide your
username and password in order to create a personal access token.
username and password in order to create a personal access token.
2. Or, create a personal access token yourself on GitHub, then set them up
using an editor.
using an editor.


If you prefer option 2, [follow these instructions](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
Expand Down Expand Up @@ -97,18 +97,18 @@ To obtain the Jenkins API token
\<your-github-username\> with your own GitHub username).
2. Click on the `ADD NEW TOKEN` button in the `API Token` section.
3. Enter an identifiable name (for example, `node-core-utils`) for this
token in the inbox that appears, and click `GENERATE`.
token in the inbox that appears, and click `GENERATE`.
4. Copy the generated token.
5. Add it into your `ncurc` file (`~/.ncurc` or `$XDG_CONFIG_HOME/ncurc`)
with `jenkins_token` as key, like this:
with `jenkins_token` as key, like this:

```json
{
"username": "your_github_username",
"token": "your_github_token",
"jenkins_token": "your_jenkins_token"
}
```
```json
{
"username": "your_github_username",
"token": "your_github_token",
"jenkins_token": "your_jenkins_token"
}
```


### Make sure your credentials won't be committed
Expand Down Expand Up @@ -136,8 +136,8 @@ If you encounter an error that you cannot fix by yourself, please

1. Make sure you update NCU to the latest version
2. Try again with the `NCU_VERBOSITY=debug` environment variable set and
open an issue at https://github.com/nodejs/node-core-utils/issues with
detailed logs.
open an issue at https://github.com/nodejs/node-core-utils/issues with
detailed logs.

## Contributing

Expand Down
26 changes: 13 additions & 13 deletions docs/ncu-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,24 +106,24 @@ Unstable https://ci.nodejs.org/job/node-test-commit-arm-fanned/15212/
Possible use cases:

1. Walk CI for the latest 100 runs of `node-test-pull-request`,
aggregate failures, write the results into a Markdown file,
and then cache the responses from Jenkins so that the next time the command
is run, it picks up cached data written on disk for jobs whose results
are known.
aggregate failures, write the results into a Markdown file,
and then cache the responses from Jenkins so that the next time the command
is run, it picks up cached data written on disk for jobs whose results
are known.

Note: results are cached in `${ncu_installation_path}/.ncu/cache`, so you
may want to clean it up from time to time.
Note: results are cached in `${ncu_installation_path}/.ncu/cache`, so you
may want to clean it up from time to time.

```
ncu-ci walk pr --stats --cache --markdown results.md
```
```
ncu-ci walk pr --stats --cache --markdown results.md
```

2. Walk CI for the latest 100 runs of `node-test-pull-request`, and then write the
failures into a JSON file named database.json.
failures into a JSON file named database.json.

```
ncu-ci walk pr --json database.json
```
```
ncu-ci walk pr --json database.json
```

### `ncu-ci pr <jobid>`

Expand Down