Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document relevant user–facing changes introduced with #703 #711

Closed
0x2b3bfa0 opened this issue Sep 9, 2021 · 1 comment
Closed

Document relevant user–facing changes introduced with #703 #711

0x2b3bfa0 opened this issue Sep 9, 2021 · 1 comment
Assignees
Labels
documentation Markdown files

Comments

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Sep 9, 2021

#703

  • Fixes Better logging #22 by using winston as a logging library instead of manually monkey–patching and aliasing console.log and console.error to custom identifiers. Running commands on a TTY will print colorized, human readable logs; other scenarios (like piping) will produce machine-readable JSONL like in the gh command-line tool. There is a single exception handler common for all the command-line interface, eliminating all the duplicate code and delegating the exception formatting on the logging library.

  • Fixes Unify commands under a single entry point #699 by moving all the separate commands until a single command named cml and setting up aliases for backwards comaptibility.

  • Introduces automatic environment variable processing with yargs.env so cml command --long-option=value is equivalent to CML_COMMAND_LONG_OPTION=value cml without any maintenance overhead.

  • Introduces plugin support, allowing executables on the PATH to be called as subcommands from the new cml command; e.g. calling cml something will try to find and execute cml-something if it's in your path. As in gh extensions, external commands can't override internal ones under any circumstance.

  • Removes the default CMD on our container images (was set to cml-runner for no apparent reason) and sets a smart ENTRYPOINT that interprets unknown commands as cml commands. It didn't make too much sense to favor a tool over the rest and have seven similar ways of checking the installed CML version.

@0x2b3bfa0 0x2b3bfa0 added the documentation Markdown files label Sep 10, 2021
@dacbd
Copy link
Contributor

dacbd commented Feb 17, 2023

docs have been updated

@dacbd dacbd closed this as completed Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files
Projects
None yet
Development

No branches or pull requests

2 participants