Add ci --fetch-depth, deprecate ci --unshallow (#1233)

* Add `ci --fetch-depth`, deprecate `ci --unshallow`

* Edit formatting of expected `cml ci --help` output

* Remove `isNaN` check, already handled by Yargs lib

* Fix negative `fetchDepth`s using `coerce` in Yargs

* Apply suggestions from code review

Co-authored-by: Daniel Barnes <dabarnes2b@gmail.com>

* Reduce duplicate logic, and replace `coerce` with different condition

Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>

* Assignment to constant variable

Co-authored-by: Helio Machado <0x2b3bfa0+git@googlemail.com>
Co-authored-by: Daniel Barnes <dabarnes2b@gmail.com>
Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>

Author: 4 people

bin/cml/repo/prepare.js

@@ -20,10 +20,17 @@ exports.builder = (yargs) =>
     .options(exports.options);
 
 exports.options = kebabcaseKeys({
+  fetchDepth: {
+    type: 'number',
+    default: 1,
+    description:
+      'Number of commits to fetch. 0 indicates all history for all branches and tags'
+  },
   unshallow: {
     type: 'boolean',
     description:
-      'Fetch as much as possible, converting a shallow repository to a complete one'
+      'Fetch as much as possible, converting a shallow repository to a complete one',
+    hidden: true
   },
   userEmail: {
     type: 'string',

bin/cml/repo/prepare.test.js

@@ -20,10 +20,10 @@ describe('CML e2e', () => {
         --help    Show help                                                  [boolean]
 
       Options:
-        --unshallow   Fetch as much as possible, converting a shallow repository to a
-                      complete one                                           [boolean]
-        --user-email  Git user email         [string] [default: \\"olivaw@iterative.ai\\"]
-        --user-name   Git user name                  [string] [default: \\"Olivaw[bot]\\"]"
+        --fetch-depth  Number of commits to fetch. 0 indicates all history for all
+                       branches and tags                         [number] [default: 1]
+        --user-email   Git user email        [string] [default: \\"olivaw@iterative.ai\\"]
+        --user-name    Git user name                 [string] [default: \\"Olivaw[bot]\\"]"
     `);
   });
 });

src/cml.js

@@ -469,15 +469,19 @@ class CML {
       userName = GIT_USER_NAME,
       remote = GIT_REMOTE
     } = opts;
+    let { fetchDepth = 1 } = opts;
 
     const driver = this.getDriver();
     await exec(await driver.updateGitConfig({ userName, userEmail, remote }));
     if (unshallow) {
       if ((await exec('git rev-parse --is-shallow-repository')) === 'true') {
-        await exec('git fetch --unshallow');
+        fetchDepth = 0;
       }
     }
-    await exec('git fetch --all');
+    if (fetchDepth <= 0) {
+      return await exec('git fetch --all --unshallow');
+    }
+    return await exec(`git fetch --all --depth=${fetchDepth}`);
   }
 
   async prCreate(opts = {}) {