Introduce subcommands in a backwards-compatible way

[0x2b3bfa0]

This pull request renames all the commands in a backwards-compatible way, and closes #762.

Functionality remains unchanged, and the only difference is that cml <balderdash> can also be called by using cml <noun> <verb> as suggested.

Dependencies

• Integrate cml publish with cml send-comment #1026 (to avoid rebase hell)

Follow-up issues

• Document new command-line interface structure cml.dev#316
• Add --publish & --watch options to cml check create #1143
• Rename the --driver global option for consistency with forge naming #1142
• Rename cml ci to follow the cml <noun> <verb> naming convention #1141
• Hide cml comment <verb> --rm-watermark option #1140

Outstanding¹ unresolved discussions

• Homonyms for command verbs
• Consistency of cml ci with the cml <noun> <verb> structure
• Behavior of cml comment create and proposal of an update verb

Footnotes

1. As per https://github.com/iterative/cml/pull/1073#issuecomment-1224095678, there might be some threads that were marked as resolved but no action was taken to address they suggestions they include. Feel free to take a look. ↩

[dacbd]

Would cml ci forever live in legacy mode?

[0x2b3bfa0]

I was toying with the idea of using cml repository configure 😅

[0x2b3bfa0]

🔔 @iterative/cml, ready for a first round of feedback?

For now, the only breaking change (as per our last meeting) is that calling cml runner with no arguments prints the help message instead of launching a local runner.

The rest of commands are backwards compatible ad nauseam and behave exactly as they did in the past, thanks to a fair amount of yargs surgery. 🤢

Reading the pull request changes is rather cumbersome. Given that tests haven't changed and are still passing,¹ I would recommend to npm install --global github:iterative/cml#command-naming-consistency and explore the new commands as users would do.

Footnotes

1. For what they're worth, of course. ↩

[casperdcl]

P.S. we don't need rerun-workflow backward compat because 'twas never documented/released :P

[casperdcl]

Gratias @0x2b3bfa0!

[0x2b3bfa0]

Nihil est, @casperdcl! ⚔️ 🤝

[0x2b3bfa0]

Next steps

• @iterative/cml, please make sure that you're happy with the result
• @iterative/scapegoat, please open follow-up issues for the items listed in the pull request body