Skip to content

Commit ee9df56

Browse files
committed
Move How to Release to be in User Guide
1 parent eaddbd9 commit ee9df56

File tree

4 files changed

+52
-55
lines changed

4 files changed

+52
-55
lines changed

doc/developer_guide/developer_guide.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,3 @@
1010
../design
1111
plugins
1212
modules/modules
13-
how_to_release

doc/developer_guide/how_to_release.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

doc/shared_content/how_release.rst

Lines changed: 0 additions & 52 deletions
This file was deleted.

doc/user_guide/how_to_release.rst

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,52 @@
1-
.. include:: ../shared_content/how_release.rst
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 -- --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 "<major>.<minor>.<patch>""
32+
33+
#. Delete the remote tag
34+
35+
.. code-block:: shell
36+
37+
git push --delete origin "<major>.<minor>.<patch>"
38+
39+
#. Fix the issue(s) which led 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 was interrupted.
51+
52+
**Solution**: Manually push the package to PyPi

0 commit comments

Comments
 (0)