From af475725eda4ad3067f302784d833afaf7bf696e Mon Sep 17 00:00:00 2001 From: Maxim Martynov Date: Mon, 31 Jul 2023 01:07:29 +0300 Subject: [PATCH] Add note about shallow clone #83 --- CHANGELOG.rst | 8 +++++++- docs/command.rst | 25 ++++++++++++++++++++++++- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 523d145..129864f 100644 --- 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 index 9dc9f60..c847499 100644 --- 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 ~~~~~~~~~~~~~