Skip to content

Commit 7d99dd9

Browse files
doc link tree problem
1 parent 95bae37 commit 7d99dd9

File tree

4 files changed

+55
-53
lines changed

4 files changed

+55
-53
lines changed

doc/developer_guide/developer_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010
../design
1111
plugins
1212
modules/modules
13-
../user_guide/how_to_release
13+
how_to_release
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../shared_content/how_release.rst

doc/shared_content/how_release.rst

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
How to Release?
2+
===============
3+
4+
Creating a Release
5+
++++++++++++++++++
6+
7+
#. Prepare the project for a new release:
8+
9+
.. code-block:: shell
10+
11+
nox -s release:prepare -- [-h] [-v | --version VERSION] [-t | --type {major,minor,patch}]
12+
13+
#. Merge your **Pull Request** to the **default branch**
14+
15+
#. Trigger the release:
16+
17+
.. code-block:: shell
18+
19+
nox -s release:trigger
20+
21+
What to do if the release failed?
22+
+++++++++++++++++++++++++++++++++
23+
24+
The release failed during pre-release checks
25+
--------------------------------------------
26+
27+
#. Delete the local tag
28+
29+
.. code-block:: shell
30+
31+
git tag -d "${TAG}"
32+
33+
#. Delete the remote tag
34+
35+
.. code-block:: shell
36+
37+
git push --delete origin "${TAG}"
38+
39+
#. Fix the issue(s) which lead to the failing checks
40+
#. Start the release process from the beginning
41+
42+
43+
One of the release steps failed (Partial Release)
44+
-------------------------------------------------
45+
#. Check the Github action/workflow to see which steps failed
46+
#. Finish or redo the failed release steps manually
47+
48+
.. note:: Example
49+
50+
**Scenario**: Publishing of the release on Github was successfully but during the PyPi release, the upload step got interrupted.
51+
52+
**Solution**: Manually push the package to PyPi

doc/user_guide/how_to_release.rst

Lines changed: 1 addition & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1 @@
1-
How to Release?
2-
===============
3-
4-
Creating a Release
5-
++++++++++++++++++
6-
7-
#. Prepare the project for a new release:
8-
9-
.. code-block:: shell
10-
11-
nox -s release:prepare -- [-h] [-v | --version VERSION] [-t | --type {major,minor,patch}]
12-
13-
#. Merge your **Pull Request** to the **default branch**
14-
15-
#. Trigger the release:
16-
17-
.. code-block:: shell
18-
19-
nox -s release:trigger
20-
21-
What to do if the release failed?
22-
+++++++++++++++++++++++++++++++++
23-
24-
The release failed during pre-release checks
25-
--------------------------------------------
26-
27-
#. Delete the local tag
28-
29-
.. code-block:: shell
30-
31-
git tag -d "${TAG}"
32-
33-
#. Delete the remote tag
34-
35-
.. code-block:: shell
36-
37-
git push --delete origin "${TAG}"
38-
39-
#. Fix the issue(s) which lead to the failing checks
40-
#. Start the release process from the beginning
41-
42-
43-
One of the release steps failed (Partial Release)
44-
-------------------------------------------------
45-
#. Check the Github action/workflow to see which steps failed
46-
#. Finish or redo the failed release steps manually
47-
48-
.. note:: Example
49-
50-
**Scenario**: Publishing of the release on Github was successfully but during the PyPi release, the upload step got interrupted.
51-
52-
**Solution**: Manually push the package to PyPi
1+
.. include:: ../shared_content/how_release.rst

0 commit comments

Comments
 (0)