Introduce subcommands in a backwards-compatible way

.gitignore

@@ -1,5 +1,4 @@
 node_modules/
-runner/
 .terraform/
 .cml/
 .DS_Store

bin/cml.js

@@ -51,13 +51,29 @@ const handleError = (message, error) => {
   process.exit(1);
 };
 
-const options = {
+exports.options = {
   log: {
     type: 'string',
     description: 'Maximum log level',
     coerce: (value) => configureLogger(value) && value,
     choices: ['error', 'warn', 'info', 'debug'],
     default: 'info'
+  },
+  driver: {
+    type: 'string',
+    choices: ['github', 'gitlab', 'bitbucket'],
+    description:
+      'Forge where the repository is hosted. If not specified, it will be inferred from the environment'
+  },
+  repo: {
+    type: 'string',
+    description:
+      'Repository. If not specified, it will be inferred from the environment'
+  },
+  token: {
+    type: 'string',
+    description:
+      'Personal access token. If not specified, it will be inferred from the environment'
   }
 };
 
@@ -81,8 +97,9 @@ for (const [oldName, newName] of Object.entries(legacyEnvironmentVariables)) {
 yargs
   .fail(handleError)
   .env('CML')
-  .options(options)
-  .commandDir('./cml', { exclude: /\.test\.js$/ })
+  .options(exports.options)
+  .commandDir('./cml')
+  .commandDir('./legacy')
   .command('$0 <command>', false, (builder) => builder.strict(false), runPlugin)
   .recommendCommands()
   .demandCommand()

bin/cml.test.js

@@ -8,23 +8,26 @@ describe('command-line interface tests', () => {
       "cml.js <command>
 
       Commands:
-        cml.js ci                                 Fixes specific CI setups
-        cml.js pr <glob path...>                  Create a pull request with the
-                                                  specified files
-        cml.js publish <asset>                    Upload an image to build a report
-        cml.js rerun-workflow                     Reruns a workflow given the jobId or
-                                                  workflow Id
-        cml.js runner                             Launch and register a self-hosted
-                                                  runner
-        cml.js send-comment <markdown file>       Comment on a commit
-        cml.js send-github-check <markdown file>  Create a check report
-        cml.js tensorboard-dev                    Get a tensorboard link
+        cml.js check              Manage continuous integration checks
+        cml.js pr <glob path...>  Manage pull requests
+        cml.js report             Manage reports
+        cml.js repository         Manage repository settings
+        cml.js runner             Manage continuous integration self-hosted runners
+        cml.js tensorboard        Manage tensorboard.dev agents
+        cml.js workflow           Manage continuous integration workflows
 
       Options:
         --help     Show help                                                 [boolean]
         --version  Show version number                                       [boolean]
         --log      Maximum log level
-                [string] [choices: \\"error\\", \\"warn\\", \\"info\\", \\"debug\\"] [default: \\"info\\"]"
+                [string] [choices: \\"error\\", \\"warn\\", \\"info\\", \\"debug\\"] [default: \\"info\\"]
+        --driver   Forge where the repository is hosted. If not specified, it will be
+                   inferred from the environment
+                                   [string] [choices: \\"github\\", \\"gitlab\\", \\"bitbucket\\"]
+        --repo     Repository. If not specified, it will be inferred from the
+                   environment                                                [string]
+        --token    Personal access token. If not specified, it will be inferred from
+                   the environment                                            [string]"
     `);
   });
 });

bin/cml/attachment.js

@@ -0,0 +1,8 @@
+exports.command = 'attachment';
+exports.description = false;
+exports.builder = (yargs) =>
+  yargs
+    .commandDir('./attachment', { exclude: /\.test\.js$/ })
+    .recommendCommands()
+    .demandCommand()
+    .strict();

bin/cml/attachment/publish.js

@@ -0,0 +1,69 @@
+const fs = require('fs').promises;
+const kebabcaseKeys = require('kebabcase-keys');
+const winston = require('winston');
+
+const CML = require('../../../src/cml').default;
+
+exports.command = 'publish <asset>';
+exports.description = 'publish an asset';
+
+exports.handler = async (opts) => {
+  if (opts.gitlabUploads) {
+    winston.warn(
+      '--gitlab-uploads will be deprecated soon. Use --native instead.'
+    );
+    opts.native = true;
+  }
+
+  const { file, repo, native } = opts;
+
+  const path = opts.asset;
+  const cml = new CML({ ...opts, repo: native ? repo : 'cml' });
+
+  const output = await cml.publish({
+    ...opts,
+    path
+  });
+
+  if (!file) console.log(output);
+  else await fs.writeFile(file, output);
+};
+
+exports.builder = (yargs) => yargs.env('CML_PUBLISH').options(exports.options);
+
+exports.options = kebabcaseKeys({
+  md: {
+    type: 'boolean',
+    description: 'Output in markdown format [title || name](url).'
+  },
+  title: {
+    type: 'string',
+    alias: 't',
+    description: 'Markdown title [title](url) or ![](url title).'
+  },
+  native: {
+    type: 'boolean',
+    description:
+      "Uses driver's native capabilities to upload assets instead of CML's storage. Not available on GitHub."
+  },
+  gitlabUploads: {
+    type: 'boolean',
+    hidden: true
+  },
+  rmWatermark: {
+    type: 'boolean',
+    description: 'Avoid CML watermark.'
+  },
+  mimeType: {
+    type: 'string',
+    description:
+      'Specifies the mime-type. If not set guess it from the content.'
+  },
+  file: {
+    type: 'string',
+    alias: 'f',
+    description:
+      'Append the output to the given file. Create it if does not exist.',
+    hidden: true
+  }
+});

bin/cml/publish.test.js → bin/cml/attachment/publish.test.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { exec } = require('../../src/utils');
+const { exec } = require('../../../src/utils');
 
 describe('CML e2e', () => {
   test('cml publish --help', async () => {
@@ -8,27 +8,25 @@ describe('CML e2e', () => {
     expect(output).toMatchInlineSnapshot(`
       "cml.js publish <asset>
 
-      Upload an image to build a report
-
       Options:
             --help          Show help                                        [boolean]
             --version       Show version number                              [boolean]
             --log           Maximum log level
                 [string] [choices: \\"error\\", \\"warn\\", \\"info\\", \\"debug\\"] [default: \\"info\\"]
+            --driver        Forge where the repository is hosted. If not specified, it
+                            will be inferred from the environment
+                                   [string] [choices: \\"github\\", \\"gitlab\\", \\"bitbucket\\"]
+            --repo          Repository. If not specified, it will be inferred from the
+                            environment                                       [string]
+            --token         Personal access token. If not specified, it will be
+                            inferred from the environment                     [string]
             --md            Output in markdown format [title || name](url).  [boolean]
         -t, --title         Markdown title [title](url) or ![](url title).    [string]
             --native        Uses driver's native capabilities to upload assets instead
                             of CML's storage. Not available on GitHub.       [boolean]
             --rm-watermark  Avoid CML watermark.                             [boolean]
             --mime-type     Specifies the mime-type. If not set guess it from the
-                            content.                                          [string]
-            --repo          Specifies the repo to be used. If not specified is
-                            extracted from the CI ENV.                        [string]
-            --token         Personal access token to be used. If not specified,
-                            extracted from ENV REPO_TOKEN, GITLAB_TOKEN, GITHUB_TOKEN,
-                            or BITBUCKET_TOKEN.                               [string]
-            --driver        If not specify it infers it from the ENV.
-                                   [string] [choices: \\"github\\", \\"gitlab\\", \\"bitbucket\\"]"
+                            content.                                          [string]"
     `);
   });
 

bin/cml/check.js

@@ -0,0 +1,8 @@
+exports.command = 'check';
+exports.description = 'Manage continuous integration checks';
+exports.builder = (yargs) =>
+  yargs
+    .commandDir('./check', { exclude: /\.test\.js$/ })
+    .recommendCommands()
+    .demandCommand()
+    .strict();

bin/cml/check/create.js

@@ -0,0 +1,48 @@
+const fs = require('fs').promises;
+const kebabcaseKeys = require('kebabcase-keys');
+const CML = require('../../../src/cml').default;
+
+exports.command = 'create <markdown file>';
+exports.description = 'Create a check report';
+
+exports.handler = async (opts) => {
+  const path = opts.markdownfile;
+  const report = await fs.readFile(path, 'utf-8');
+  const cml = new CML({ ...opts });
+  await cml.checkCreate({ ...opts, report });
+};
+
+exports.builder = (yargs) =>
+  yargs.env('CML_SEND_GITHUB_CHECK').options(exports.options);
+
+exports.options = kebabcaseKeys({
+  commitSha: {
+    type: 'string',
+    alias: 'head-sha',
+    description: 'Commit SHA linked to this comment. Defaults to HEAD.'
+  },
+  conclusion: {
+    type: 'string',
+    choices: [
+      'success',
+      'failure',
+      'neutral',
+      'cancelled',
+      'skipped',
+      'timed_out'
+    ],
+    default: 'success',
+    description: 'Sets the conclusion status of the check.'
+  },
+  status: {
+    type: 'string',
+    choices: ['queued', 'in_progress', 'completed'],
+    default: 'completed',
+    description: 'Sets the status of the check.'
+  },
+  title: {
+    type: 'string',
+    default: 'CML Report',
+    description: 'Sets title of the check.'
+  }
+});

bin/cml/send-github-check.test.js → bin/cml/check/create.test.js

@@ -1,4 +1,4 @@
-const { exec } = require('../../src/utils');
+const { exec } = require('../../../src/utils');
 const fs = require('fs').promises;
 
 describe('CML e2e', () => {
@@ -36,13 +36,18 @@ describe('CML e2e', () => {
     expect(output).toMatchInlineSnapshot(`
       "cml.js send-github-check <markdown file>
 
-      Create a check report
-
       Options:
         --help                    Show help                                  [boolean]
         --version                 Show version number                        [boolean]
         --log                     Maximum log level
                 [string] [choices: \\"error\\", \\"warn\\", \\"info\\", \\"debug\\"] [default: \\"info\\"]
+        --driver                  Forge where the repository is hosted. If not
+                                  specified, it will be inferred from the environment
+                                   [string] [choices: \\"github\\", \\"gitlab\\", \\"bitbucket\\"]
+        --repo                    Repository. If not specified, it will be inferred
+                                  from the environment                        [string]
+        --token                   Personal access token. If not specified, it will be
+                                  inferred from the environment               [string]
         --commit-sha, --head-sha  Commit SHA linked to this comment. Defaults to HEAD.
                                                                               [string]
         --conclusion              Sets the conclusion status of the check.
@@ -52,11 +57,7 @@ describe('CML e2e', () => {
                     [string] [choices: \\"queued\\", \\"in_progress\\", \\"completed\\"] [default:
                                                                           \\"completed\\"]
         --title                   Sets title of the check.
-                                                      [string] [default: \\"CML Report\\"]
-        --repo                    Specifies the repo to be used. If not specified is
-                                  extracted from the CI ENV.                  [string]
-        --token                   GITHUB_TOKEN or Github App token. Personal access
-                                  token won't work                            [string]"
+                                                      [string] [default: \\"CML Report\\"]"
     `);
   });
 });