Skip to content

Commit dbf912c

Browse files
committed
Update CONTRIBUTING.rst
1 parent e34eeeb commit dbf912c

File tree

1 file changed

+7
-26
lines changed

1 file changed

+7
-26
lines changed

CONTRIBUTING.rst

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -62,39 +62,20 @@ whatever you need with ``uv run``.
6262
Creating a New Release
6363
^^^^^^^^^^^^^^^^^^^^^^
6464

65-
It is proposed to perform these steps for creating a new release:
65+
These steps for creating a new release are proposed to be taken only after
66+
ensuring that CI (unit tests, sphinx for RTD_, build of wheel and source distribution)
67+
raised no errors.
6668

6769
#. Bump version number in ``sfs/__init__.py``
6870
#. Update ``NEWS.rst``
6971
#. Commit those changes as "Release x.y.z"
7072
#. Create an (annotated) tag with ``git tag -a x.y.z``
7173
#. Push the commit and the tag to Github
72-
#. Github workflow publish.yml will handle the build and upload to PyPi
74+
#. The workflow ``.github/workflows/publish.yml`` will handle the build and the
75+
upload to PyPI
7376
#. `Add release notes`_ containing a link to PyPI and the bullet points
74-
from ``NEWS.rst``
75-
#. Check that the new release was built correctly on RTD_
76-
and select the new release as the default version
77-
78-
Alternatively, an extra branch and PR can be utilised as follows:
79-
80-
#. Create a branch from the current master branch state. In this new branch:
81-
#. Bump version number in ``sfs/__init__.py``
82-
#. Update ``NEWS.rst``
83-
#. Commit those changes as "Release x.y.z", push this commit and make a PR.
84-
This will trigger workflows to check that everything is fine, the PR is a
85-
nice additional documentation of this release process.
86-
#. Create an (annotated) tag with ``git tag -a x.y.z`` and push it
87-
#. Due to this tag push Github workflow publish.yml will handle the build
88-
and upload to PyPi
89-
#. Merge the PR by ``git merge branch_name --ff-only``. This is needed for
90-
preserving the release and tag commits as they need to appear exactly this
91-
way in the master branch history.
92-
#. Delete the branch
93-
#. `Add release notes`_ containing a link to PyPI and the bullet points
94-
from ``NEWS.rst``
95-
#. Check that the new release was built correctly on RTD_
96-
and select the new release as the default version
97-
77+
from the updated ``NEWS.rst``
78+
#. Select the new release as the default on RTD_
9879

9980
.. _add release notes: https://github.com/sfstoolbox/sfs-python/tags
10081
.. _RTD: https://readthedocs.org/projects/sfs-python/builds/

0 commit comments

Comments
 (0)