Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 2.5 KB

ncu-ci.md

File metadata and controls

80 lines (59 loc) · 2.5 KB
Raw

ncu-ci

Parse the results of a Jenkins CI run in https://ci.nodejs.org/ and display a summary for all the failures.

Supported jobs:

ncu-ci <command>

Commands:
  ncu-ci rate <type>        Calculate the green rate of a CI job in the last 100
                            runs
  ncu-ci walk <type>        Walk the CI and display the failures
  ncu-ci url <url>          Automatically detect CI type and show results
  ncu-ci pr <jobid>         Show results of a node-test-pull-request CI job
  ncu-ci commit <jobid>     Show results of a node-test-commit CI job
  ncu-ci benchmark <jobid>  Show results of a benchmark-node-micro-benchmarks CI
                            job

Options:
  --version   Show version number                                      [boolean]
  --copy      Write the results as markdown to clipboard        [default: false]
  --json      Write the results as json to the path                     [string]
  --markdown  Write the results as markdown to the path                 [string]
  --help      Show help                                                [boolean]

Example

Get the CI results of PR 12345 (including latest results of each type of supported CI) and copy the summaries into clipboard:

ncu-ci url https://github.com/nodejs/node/pull/12345 --copy

Get the results of job #12345 of node-test-pull-request:

ncu-ci pr 12345

Walk the CI for the latest 100 runs of node-test-pull-request, aggregate the failures, then write the results into a Markdown file, and 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_intallation_path}/.ncu/cache, you may want to clean it up from time to time.

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

Walk the CI for the latest 100 runs of node-test-pull-request, write the failures into a JSON file

ncu-ci walk pr --json database.json

Calculate the green rate of the CI for CI Health History

ncu-ci rate pr

Caveats

The CI failures are parsed using pattern matching and could be incorrect. Feel free to open a pull request whenever you find a case that ncu-ci does not handle well.