Remove default value for --fetch-depth (#1246)

* temp * no default for fetch-depth * test update * tidy unshallow logic checks * slight docs update Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>
iterative · Oct 31, 2022 · fc9e235 · fc9e235
1 parent 17a045e
commit fc9e235
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 13 deletions.
diff --git a/bin/cml/repo/prepare.js b/bin/cml/repo/prepare.js
@@ -22,9 +22,7 @@ exports.builder = (yargs) =>
 exports.options = kebabcaseKeys({
   fetchDepth: {
     type: 'number',
-    default: 1,
-    description:
-      'Number of commits to fetch. 0 indicates all history for all branches and tags'
+    description: 'Number of commits to fetch (use `0` for all branches & tags)'
   },
   unshallow: {
     type: 'boolean',

diff --git a/bin/cml/repo/prepare.test.js b/bin/cml/repo/prepare.test.js
@@ -20,8 +20,8 @@ describe('CML e2e', () => {
         --help    Show help                                                  [boolean]
 
       Options:
-        --fetch-depth  Number of commits to fetch. 0 indicates all history for all
-                       branches and tags                         [number] [default: 1]
+        --fetch-depth  Number of commits to fetch (use \`0\` for all branches & tags)
+                                                                              [number]
         --user-email   Git user email        [string] [default: \\"olivaw@iterative.ai\\"]
         --user-name    Git user name                 [string] [default: \\"Olivaw[bot]\\"]"
     `);

diff --git a/src/cml.js b/src/cml.js
@@ -501,19 +501,19 @@ class CML {
       userName = GIT_USER_NAME,
       remote = GIT_REMOTE
     } = opts;
-    let { fetchDepth = 1 } = opts;
+    const { fetchDepth = unshallow ? 0 : undefined } = 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') {
-        fetchDepth = 0;
+    if (fetchDepth !== undefined) {
+      if (fetchDepth <= 0) {
+        if ((await exec('git rev-parse --is-shallow-repository')) === 'true') {
+          return await exec('git fetch --all --unshallow');
+        }
+      } else {
+        return await exec(`git fetch --all --depth=${fetchDepth}`);
       }
     }
-    if (fetchDepth <= 0) {
-      return await exec('git fetch --all --unshallow');
-    }
-    return await exec(`git fetch --all --depth=${fetchDepth}`);
   }
 
   async prCreate(opts = {}) {