Skip to content

Commit

Permalink
Small adjustments to the release process
Browse files Browse the repository at this point in the history
- Adding some notes here so I do not forget the social media posting
- Add note to check RTD to verify the changelog looks good
- Sign the tags
  • Loading branch information
bdraco committed Feb 25, 2025
1 parent 14936fd commit 88d3a07
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/contributing-admins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ To create a new release:
#. Run ``towncrier``.
#. Check and cleanup the changes in ``CHANGES.rst``.
#. Checkout a new branch: e.g. ``git checkout -b release/v3.8.6``
#. Commit and create a PR. Once PR is merged, continue.
#. Commit and create a PR. Verify the changelog and release notes look good on Read the Docs. Once PR is merged, continue.
#. Go back to the release branch: e.g. ``git checkout 3.8 && git pull``
#. Add a tag: e.g. ``git tag -a v3.8.6 -m 'Release 3.8.6'``
#. Add a tag: e.g. ``git tag -a v3.8.6 -m 'Release 3.8.6' -s``
#. Push the tag: e.g. ``git push origin v3.8.6``
#. Monitor CI to ensure release process completes without errors.

Expand All @@ -49,6 +49,8 @@ first merge into the newer release branch (e.g. 3.8 into 3.9) and then to master

Back on the original release branch, bump the version number and append ``.dev0`` in ``__init__.py``.

Post the release announcement to social media.

If doing a minor release:

#. Create a new release branch for future features to go to: e.g. ``git checkout -b 3.10 3.9 && git push``
Expand Down

0 comments on commit 88d3a07

Please sign in to comment.