6.5. Release Procedure¶
The following procedures gives a short overview of what steps are needed to create a new release.
These steps are interesting for the release manager only.
6.5.1. Prepare the Release¶
all issues for a new release are closed: https://github.com/python-semver/python-semver/issues.
all pull requests that should be included in this release are merged: https://github.com/python-semver/python-semver/pulls.
continuous integration for latest build was passing: https://github.com/python-semver/python-semver/actions.
Create a new branch
If one or several supported Python versions have been removed or added, verify that the following files have been updated:
Verify that the version in file
src/semver/__about__.pyhas been updated and follows the Semver specification.
Add eventually new contributor(s) to CONTRIBUTORS.
Check if all changelog entries are created. If some are missing, create them.
Show the new draft CHANGELOG entry for the latest release with:
$ tox -e changelog
Check the output. If you are not happy, update the files in the
changelog.d/directory. If everything is okay, build the new
$ tox -e changelog -- build
Build the documentation and check the output:
$ tox -e docs
Commit all changes, push, and create a pull request.
6.5.2. Create the New Release¶
Ensure that long description (README.rst) can be correctly rendered by Pypi using
Clean up your local Git repository. Be careful, as it will remove all files which are not versioned by Git:
$ git clean -xfd
Before you create your distribution files, clean the directory too:
$ rm dist/*
Create the distribution files (wheel and source):
$ tox -e prepare-dist
Upload the wheel and source to TestPyPI first:
$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
If you have a
testpypisection, the upload can be simplified:
$ twine upload --repository testpypi dist/*
Check if everything is okay with the wheel. Check also the web site
If everything looks fine, merge the pull request.
Upload to PyPI:
$ git clean -xfd $ tox -e prepare-dist $ twine upload dist/*
Go to https://pypi.org/project/semver/ to verify that new version is online and the page is rendered correctly.