ncu-ci: add --markdown option

Author: joyeecheung

bin/ncu-ci

@@ -15,7 +15,7 @@ const {
   listBuilds, FailureAggregator, jobCache
 } = require('../lib/ci/ci_result_parser');
 const clipboardy = require('clipboardy');
-const { writeJson } = require('../lib/file');
+const { writeJson, writeFile } = require('../lib/file');
 
 const { runPromise } = require('../lib/run');
 const auth = require('../lib/auth');
@@ -119,6 +119,10 @@ const argv = yargs
     type: 'string',
     describe: 'Write the results as json to the path'
   })
+  .option('markdown', {
+    type: 'string',
+    describe: 'Write the results as markdown to the path'
+  })
   .help()
   .argv;
 
@@ -142,8 +146,8 @@ async function getResults(cli, request, job) {
 }
 
 async function runQueue(queue, cli, request, argv) {
-  let dataToCopy = '';
-  let dataToJson = [];
+  let json = [];
+  let markdown = '';
 
   for (let i = 0; i < queue.length; ++i) {
     const job = queue[i];
@@ -158,16 +162,15 @@ async function runQueue(queue, cli, request, argv) {
     const build = await getResults(cli, request, job);
     build.display();
 
-    if (argv.copy) {
-      dataToCopy += build.formatAsMarkdown();
+    json = json.concat(build.formatAsJson());
+    if ((argv.copy || argv.markdown) && !argv.stats) {
+      markdown += build.formatAsMarkdown();
     }
-
-    dataToJson = dataToJson.concat(build.formatAsJson());
   }
 
   return {
-    json: dataToJson,
-    copy: dataToCopy
+    json,
+    markdown
   };
 }
 
@@ -262,17 +265,24 @@ async function main(command, argv) {
       cli.separator('Stats');
       cli.log('');
       aggregator.display();
-      if (argv.copy) {
-        data.copy = aggregator.formatAsMarkdown();
+
+      if (argv.markdown || argv.copy) {
+        data.markdown = aggregator.formatAsMarkdown();
       }
     }
 
     if (argv.copy) {
-      clipboardy.writeSync(data.copy);
+      clipboardy.writeSync(data.markdown);
       cli.separator('');
       cli.log(`Written markdown to clipboard`);
     }
 
+    if (argv.markdown) {
+      writeFile(argv.markdown, data.markdown);
+      cli.separator('');
+      cli.log(`Written markdown to ${argv.markdown}`);
+    }
+
     if (argv.json) {
       writeJson(argv.json, data.json);
       cli.separator('');

docs/ncu-ci.md

@@ -15,18 +15,19 @@ 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 store the failures
+  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]
-  --help     Show help                                                 [boolean]
+  --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
@@ -44,6 +45,20 @@ 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