Merge pull request #1092 from arturcic/main

Allow to disable the shallow clone check (by default it will check if it's shallow clone)
GitTools · Mar 12, 2024 · a282519 · a282519
2 parents 33df830 + 827776a
commit a282519
Show file tree

Hide file tree

Showing 11 changed files with 67 additions and 21 deletions.
diff --git a/dist/azure/gitversion/execute/bundle.js b/dist/azure/gitversion/execute/bundle.js
diff --git a/dist/azure/gitversion/execute/task.json b/dist/azure/gitversion/execute/task.json
@@ -64,6 +64,14 @@
             "required": false,
             "helpMarkDown": "Whether to disable GitVersion normalization"
         },
+        {
+            "name": "disableShallowCloneCheck",
+            "type": "boolean",
+            "label": "Disable Shallow Clone Check",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Whether to disable GitVersion shallow clone check"
+        },
         {
             "name": "useConfigFile",
             "type": "boolean",

diff --git a/dist/azure/gitversion/setup/bundle.js b/dist/azure/gitversion/setup/bundle.js
diff --git a/dist/github/gitversion/execute/bundle.js b/dist/github/gitversion/execute/bundle.js
diff --git a/dist/github/gitversion/setup/bundle.js b/dist/github/gitversion/setup/bundle.js
diff --git a/docs/examples/azure/gitversion/execute/usage-examples.md b/docs/examples/azure/gitversion/execute/usage-examples.md
@@ -37,6 +37,10 @@ disableNormalization:
   description: Whether to disable GitVersion normalization
   required: false
   default: 'false'
+disableShallowCloneCheck:
+  description: Whether to disable the check for shallow clone
+  required: false
+  default: 'false'
 useConfigFile:
   description: Whether to use a custom configuration file
   required: false

diff --git a/docs/examples/github/gitversion/execute/usage-examples.md b/docs/examples/github/gitversion/execute/usage-examples.md
@@ -39,6 +39,10 @@ disableNormalization:
   description: Whether to disable GitVersion normalization
   required: false
   default: 'false'
+disableShallowCloneCheck:
+  description: Whether to disable the check for shallow clone
+  required: false
+  default: 'false'
 useConfigFile:
   description: Whether to use a custom configuration file
   required: false

diff --git a/gitversion/execute/action.yml b/gitversion/execute/action.yml
@@ -20,6 +20,10 @@ inputs:
     description: Whether to disable GitVersion normalization
     required: false
     default: 'false'
+  disableShallowCloneCheck:
+    description: Whether to disable the check for shallow clone
+    required: false
+    default: 'false'
   useConfigFile:
     description: Whether to use a custom configuration file
     required: false

diff --git a/src/tools/gitversion/models.ts b/src/tools/gitversion/models.ts
@@ -4,6 +4,7 @@ export enum ExecuteFields {
     targetPath = 'targetPath',
     disableCache = 'disableCache',
     disableNormalization = 'disableNormalization',
+    disableShallowCloneCheck = 'disableShallowCloneCheck',
     useConfigFile = 'useConfigFile',
     configFilePath = 'configFilePath',
     overrideConfig = 'overrideConfig',
@@ -17,6 +18,7 @@ export interface GitVersionSettings {
     [ExecuteFields.targetPath]: string
     [ExecuteFields.disableCache]: boolean
     [ExecuteFields.disableNormalization]: boolean
+    [ExecuteFields.disableShallowCloneCheck]: boolean
     [ExecuteFields.useConfigFile]: boolean
     [ExecuteFields.configFilePath]: string
     [ExecuteFields.overrideConfig]: string[]

diff --git a/src/tools/gitversion/settings.ts b/src/tools/gitversion/settings.ts
@@ -15,6 +15,7 @@ export class GitVersionSettingsProvider extends SettingsProvider implements IGit
 
         const disableCache = this.buildAgent.getBooleanInput(ExecuteFields.disableCache)
         const disableNormalization = this.buildAgent.getBooleanInput(ExecuteFields.disableNormalization)
+        const disableShallowCloneCheck = this.buildAgent.getBooleanInput(ExecuteFields.disableShallowCloneCheck)
 
         const useConfigFile = this.buildAgent.getBooleanInput(ExecuteFields.useConfigFile)
         const configFilePath = this.buildAgent.getInput(ExecuteFields.configFilePath)
@@ -31,6 +32,7 @@ export class GitVersionSettingsProvider extends SettingsProvider implements IGit
             targetPath,
             disableCache,
             disableNormalization,
+            disableShallowCloneCheck,
             useConfigFile,
             configFilePath,
             overrideConfig,

diff --git a/src/tools/gitversion/tool.ts b/src/tools/gitversion/tool.ts
@@ -26,11 +26,13 @@ export class GitVersionTool extends DotnetTool implements IGitVersionTool {
     public async run(options: GitVersionSettings): Promise<IExecResult> {
         const workDir = this.getRepoDir(options)
 
-        const isShallowResult = await this.execute('git', ['-C', workDir, 'rev-parse', '--is-shallow-repository'])
-        if (isShallowResult.code === 0 && isShallowResult.stdout.trim() === 'true') {
-            throw new Error(
-                'The repository is shallow. Consider disabling shallow clones. See https://github.com/GitTools/actions/blob/main/docs/cloning.md for more information.'
-            )
+        if (!options.disableShallowCloneCheck) {
+            const isShallowResult = await this.execute('git', ['-C', workDir, 'rev-parse', '--is-shallow-repository'])
+            if (isShallowResult.code === 0 && isShallowResult.stdout.trim() === 'true') {
+                throw new Error(
+                    'The repository is shallow. Consider disabling shallow clones. See https://github.com/GitTools/actions/blob/main/docs/cloning.md for more information.'
+                )
+            }
         }
 
         const args = this.getArguments(workDir, options)