Skip to content

Commit 89c1f23

Browse files
committed
Documentation: Update information about release procedure
1 parent cbbf143 commit 89c1f23

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

DEVELOP.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,14 @@ In the release branch:
7070

7171
- Add a section for the new version in the ``CHANGES.rst`` file
7272

73-
- Commit your changes with a message like "prepare release x.y.z"
73+
- Commit your changes with a message like "Release x.y.z"
7474

7575
- Push to origin/<release_branch>
7676

7777
- Create a tag by running ``git tag -s <version>`` and push it ``git push --tags``.
78-
This will trigger a Github action which releases the new version to PyPi.
78+
This will trigger a Github action which releases the new version to PyPI.
79+
80+
- Announce the new release on the `GitHub Releases`_ page.
7981

8082
On branch ``main``:
8183

@@ -113,7 +115,7 @@ The docs are automatically built from Git by `Read the Docs`_ and there is
113115
nothing special you need to do to get the live docs to update.
114116

115117
.. _@crate/docs: https://github.com/orgs/crate/teams/docs
116-
.. _buildout: https://pypi.python.org/pypi/zc.buildout
118+
.. _GitHub Releases: https://github.com/crate/crate-python/releases
117119
.. _PyPI: https://pypi.python.org/pypi
118120
.. _Python versions: https://docs.astral.sh/uv/concepts/python-versions/
119121
.. _Read the Docs: http://readthedocs.org

0 commit comments

Comments
 (0)