Merge pull request #1070 from arturcic/main

Check for shallow clone for GitVersion execute action/task

.azure/ci.yml

@@ -27,6 +27,7 @@ jobs:
 
   steps:
     - checkout: self
+      displayName: Checkout
       fetchDepth: '0'
     - pwsh: |
         npm install

docs/cloning.md

@@ -0,0 +1,19 @@
+In order for the gitversion to properly work you need to clone the repository with the entire history:
+
+```yaml
+# GitHub Actions syntax
+steps:
+  -
+    name: Checkout
+    uses: actions/checkout@v4
+    with:
+      fetch-depth: 0
+```
+
+```yaml
+# Azure DevOps syntax
+steps:
+  - checkout: self
+    displayName: Checkout
+    fetchDepth: '0'
+```

docs/examples/github/gitversion/setup/usage-examples.md

@@ -33,7 +33,7 @@ In order for the gitversion to properly work you need to clone the repository wi
 steps:
   -
     name: Checkout
-    uses: actions/checkout@v3
+    uses: actions/checkout@v4
     with:
       fetch-depth: 0
 ```

src/core/dotnet-tool.ts

@@ -10,6 +10,7 @@ import { ISetupSettings } from '../tools/common/models'
 
 export interface IDotnetTool {
     disableTelemetry(): void
+
     toolInstall(toolName: string, versionRange: string, setupSettings: ISetupSettings): Promise<string>
 }
 
@@ -54,7 +55,7 @@ export class DotnetTool implements IDotnetTool {
         if (!this.versionManager.satisfies(version, versionRange, { includePrerelease: setupSettings.includePrerelease })) {
             throw new Error(
                 `Version spec '${setupSettings.versionSpec}' resolved as '${version}' does not satisfy the range '${versionRange}'.` +
-                    'Check https://raw.githubusercontent.com/GitTools/actions/main/docs/versions.md for more information'
+                    'See https://github.com/GitTools/actions/blob/main/docs/versions.md for more information.'
             )
         }
 

src/tools/gitversion/tool.ts

@@ -23,12 +23,18 @@ export class GitVersionTool extends DotnetTool implements IGitVersionTool {
         await this.toolInstall('GitVersion.Tool', '>=5.2.0 <6.1.0', setupSettings)
     }
 
-    public run(options: GitVersionSettings): Promise<IExecResult> {
+    public async run(options: GitVersionSettings): Promise<IExecResult> {
+        const isShallowResult = await this.execute('git', ['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 workDir = this.getRepoDir(options)
 
         const args = this.getArguments(workDir, options)
 
-        return this.execute('dotnet-gitversion', args)
+        return await this.execute('dotnet-gitversion', args)
     }
 
     private getRepoDir(options: GitVersionSettings): string {