1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
=========================
Releasing pytest-subtests
=========================
This document describes the steps to make a new ``pytest-subtests`` release.
Version
-------
``master`` should always be green and a potential release candidate. ``pytest-subtests`` follows
semantic versioning, so given that the current version is ``X.Y.Z``, to find the next version number
one needs to look at the ``CHANGELOG.rst`` file:
- If there any new feature, then we must make a new **minor** release: next
release will be ``X.Y+1.0``.
- Otherwise it is just a **bug fix** release: ``X.Y.Z+1``.
Steps
-----
To publish a new release ``X.Y.Z``, the steps are as follows:
#. Create a new branch named ``release-X.Y.Z`` from the latest ``main``.
#. Update the ``CHANGELOG.rst`` file with the new release information.
#. Commit and push the branch to ``upstream`` and open a PR.
#. Once the PR is **green** and **approved**, start the ``deploy`` workflow:
.. code-block:: console
gh workflow run deploy.yml -R pytest-dev/pytest-subtests --ref release-VERSION --field version=VERSION
The PR will be automatically merged.
|
