added docs info about fetch-depth: 0

GitTools · Mar 11, 2023 · 66a4299 · 66a4299
1 parent a416195
commit 66a4299
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/examples/azure/gitversion/setup/usage-examples.md b/docs/examples/azure/gitversion/setup/usage-examples.md
@@ -31,6 +31,14 @@ preferLatestVersion:
 
 ## Usage examples
 
+In order for the gitversion to properly work you need to clone the repository with the entire history:
+
+```yaml
+steps:
+  - checkout: self
+    fetchDepth: 0
+```
+
 ### Example 1
 
 Install the latest GitVersion 5 version.

diff --git a/docs/examples/github/gitversion/setup/usage-examples.md b/docs/examples/github/gitversion/setup/usage-examples.md
@@ -27,6 +27,17 @@ ignoreFailedSources:
 
 ## Usage examples
 
+In order for the gitversion to properly work you need to clone the repository with the entire history:
+
+```yaml
+steps:
+  -
+    name: Checkout
+    uses: actions/checkout@v3
+    with:
+      fetch-depth: 0
+```
+
 ### Example 1
 
 Install the latest GitVersion 5 version.