Skip to content

Commit fc7e026

Browse files
[#1391] Update release guide docs
1 parent f1d4914 commit fc7e026

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

docs/source/Support/Developer/releaseGuide.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,29 @@ back into ``develop`` to ensure they are included in future releases.
7272

7373
Creating and Pushing Tags
7474
-------------------------
75-
Releases are published by pushing a git tag to the ``master`` branch. Our GitHub Actions workflow
76-
(``Publish Wheels``) is triggered on tag pushes matching:
77-
78-
- ``v[0-9]*`` (real releases, published to PyPI)
75+
Releases are published by pushing a git tag. The ``Publish Wheels`` GitHub Actions
76+
workflow triggers on tag pushes and routes artifacts based on the tag name:
77+
78+
.. list-table::
79+
:header-rows: 1
80+
:widths: 30 70
81+
82+
* - Tag pattern
83+
- Destination
84+
* - ``vX.Y.Z`` (no ``rc``)
85+
- PyPI (public release)
86+
* - ``vX.Y.ZrcN``
87+
- TestPyPI (release candidate)
88+
* - ``test*``
89+
- TestPyPI (ad-hoc testing)
7990

8091
This means: **pushing a tag kicks off the wheel builds on all supported
8192
platforms, builds an sdist, and then publishes the artifacts**.
8293

8394
Tag format
8495
^^^^^^^^^^
85-
Release tags must follow the format ``vX.Y.Z`` (for example, ``v2.9.0``).
96+
- Full release tags must follow the format ``vX.Y.Z`` (for example, ``v2.9.0``).
97+
- Release candidate tags follow ``vX.Y.ZrcN`` (for example, ``v2.10.2rc1``).
8698

8799
Where to tag
88100
^^^^^^^^^^^^

0 commit comments

Comments
 (0)