Skip to content

Commit

Permalink
Document release steps (#358)
Browse files Browse the repository at this point in the history
  • Loading branch information
pquentin authored May 1, 2023
1 parent b7d1a1f commit e543fe5
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,31 @@ Example Commit Message

Closes #1234567

Releasing a new version
-----------------------

#. Prepare the release pull request

* In ``requests_toolbelt/__init__.py``, bump the version number

* In ``HISTORY.rst``, include noteworthy changes under the relevant sections

* Open a pull request with the above changes, and make any changes required
to get it approved

#. "Squash and merge" the pull request in GitHub, which will give you a release
commit

#. Tag the release with that commit:

* Create the tag: ``git tag -s -a $VERSION -m "Release v$VERSION"``

* Push it the main repository (not you fork!): ``git push <remote> --tags``

#. Upload it on PyPI with ``tox -e release``

#. [Optional] Announce it where relevant (social media, GitHub issues...)

Footnotes
---------

Expand Down

0 comments on commit e543fe5

Please sign in to comment.