Added note to explain about fetchDepth restriction

GitTools · Oct 10, 2022 · d946235 · d946235
1 parent 569b4c8
commit d946235
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/examples/azure/gitversion/execute/usage-examples.md b/docs/examples/azure/gitversion/execute/usage-examples.md
@@ -4,6 +4,13 @@ Find out how to use the **gitversion/execute** task using the examples below.
 
 > The examples use the latest _0.x_ version of the GitVersion Execute task.  It is recommended to use the latest released version in your own pipelines.
 
+Note that if the pipeline is setup to use a shallow git fetch mode the GitVersion Execute task will fail. It is required to use fetchDepth of 0 like so:
+
+```yaml
+- checkout: self
+  fetchDepth: 1
+```
+
 ## Inputs
 
 The Execute GitVersion task accepts the following inputs: