Skip to content

Commit ba4f329

Browse files
committed
Update docs
1 parent 6e6dc17 commit ba4f329

File tree

3 files changed

+25
-23
lines changed

3 files changed

+25
-23
lines changed

docs/ci.rst

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _ci:
2+
3+
CI configuration
4+
----------------
5+
6+
By default, CI workflows use shallow clone of the repo to speed up clone process.
7+
But this leads to cloning repo without any tags, and thus generating version number like ``0.0.1``.
8+
9+
To avoid this, please use following settings:
10+
11+
.. code-block:: yaml
12+
:caption: Github Actions
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v3
17+
with:
18+
fetch-depth: 0
19+
20+
.. code-block:: yaml
21+
:caption: Gitlab CI
22+
23+
variables:
24+
GIT_DEPTH: 0

docs/command.rst

-23
Original file line numberDiff line numberDiff line change
@@ -92,29 +92,6 @@ This script is a wrapper for ``setuptools_git_versioning`` module, you can just
9292
9393
1.0.0
9494
95-
CI configuration
96-
----------------
97-
98-
By default, CI workflows use shallow clone of the repo to speed up clone process.
99-
But this leads to cloning repo without any tags, and thus generating version number like ``0.0.1``.
100-
101-
To avoid this, please use following settings:
102-
103-
.. code-block:: yaml
104-
:caption: Github Actions
105-
106-
steps:
107-
- name: Checkout code
108-
uses: actions/checkout@v3
109-
with:
110-
fetch-depth: 0
111-
112-
.. code-block:: yaml
113-
:caption: Gitlab CI
114-
115-
variables:
116-
GIT_DEPTH: 0
117-
11895
11996
Command help
12097
~~~~~~~~~~~~~

docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
install
1818
command
19+
ci
1920
runtime_version
2021
schemas/index
2122
options/index

0 commit comments

Comments
 (0)