add comment about versioningit

SoarGroup · May 15, 2024 · 9d58632 · 9d58632
1 parent 07195f2
commit 9d58632
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -286,6 +286,9 @@ jobs:
         with:
           # Do a complete clone, not a shallow one.
           # https://github.com/actions/checkout/#usage
+          #
+          # We need a complete clone, as versioningit uses `git describe`,
+          # which requires a commit tree to determine the latest tag.
           fetch-depth: 0
 
       - name: Show tags