cml icon indicating copy to clipboard operation
cml copied to clipboard

Rename `cml ci` to follow the `cml <noun> <verb>` naming convention

Open 0x2b3bfa0 opened this issue 3 years ago • 2 comments

The cml ci command hasn't been renamed as part of #1073 because we didn't agree on naming. See https://github.com/iterative/cml/pull/1073#discussion_r912881350 for more information.

0x2b3bfa0 avatar Sep 07 '22 10:09 0x2b3bfa0

As per cml.dev/doc/ref/ci this command “prepares Git repository for CML operations” and, lacking a better alternative, my first proposal would be renaming it to cml repo prepare to fit its description.

0x2b3bfa0 avatar Sep 07 '22 11:09 0x2b3bfa0

The current cml ci name was inspired by the npm ci command, which provides completely unrelated functionality.

0x2b3bfa0 avatar Sep 07 '22 11:09 0x2b3bfa0

though I prefer the shorthand, this does already exist for us. Re-open if this requires more discussion.

dacbd avatar Nov 14 '22 17:11 dacbd

Can we please remove the misleading deprecation warning (it recommends using cml repo prepare)?

Fine by me to do any of the following instead:

  • cml ci
  • cml ci setup
  • cml ci <verb>

casperdcl avatar Nov 25 '22 13:11 casperdcl

moved to #1287, fixed by #1288

casperdcl avatar Feb 15 '23 14:02 casperdcl