Add note about shallow clone #83

dolfinus · Jul 30, 2023 · af47572 · af47572
1 parent 533757b
commit af47572
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,7 +5,13 @@ Changelog
 ----
 
 .. changelog::
-    :version: 1.13.3
+    :version: 1.13.4
+
+    .. change::
+        :tags: docs, feature
+        :tickets: 83
+
+        Update documentation to mention shallow clone issues.
 
     .. change::
         :tags: general, feature

diff --git a/docs/command.rst b/docs/command.rst
@@ -1,7 +1,7 @@
 .. _command:
 
 Console command
------------------------------------
+---------------
 
 Package contains script `setuptools-git-versioning` which can be used for calculating version number.\
 
@@ -92,6 +92,29 @@ This script is a wrapper for ``setuptools_git_versioning`` module, you can just
 
     1.0.0
 
+CI configuration
+----------------
+
+By default, CI workflows use shallow clone of the repo to speed up clone process.
+But this leads to cloning repo without any tags, and thus generating version number like ``0.0.1``.
+
+To avoid this, please use following settings:
+
+.. code-block:: yaml
+    :caption: Github Actions
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+.. code-block:: yaml
+    :caption: Gitlab CI
+
+    variables:
+      GIT_DEPTH: 0
+
 
 Command help
 ~~~~~~~~~~~~~