Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dolfinus committed Jul 30, 2023
1 parent 6e6dc17 commit ba4f329
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 23 deletions.
24 changes: 24 additions & 0 deletions docs/ci.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _ci:

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
23 changes: 0 additions & 23 deletions docs/command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,29 +92,6 @@ 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
~~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

install
command
ci
runtime_version
schemas/index
options/index
Expand Down

0 comments on commit ba4f329

Please sign in to comment.