Make a release

Procedure

To make a release :

1. Merge everything you need into develop. Make sure it passes the tests.
2. Update HISTORY.rst, setup.cfg and pyproject.toml with the new release.
3. Checkout on the master branch.
4. Merge develop into master. Make sure it passes the tests on GitHub Actions and that the wheels build properly, this is the last step before the release where the whole code is tested!
5. Create a tag with the new version (e.g., v0.33.1) and commit on Git. Do not push yet!
6. Before pushing a tag, you might check whether PyPI will be able to render the package description. To do so:

• Create a source distribution using python setup.py sdist in a terminal
• Check the distribution using twine check dist/*

This should mark the checks as passed and will display an error otherwise. See this link for more information.

7. If the wheels passed inspection, push the tag. The name of the tag should be displayed (e.g., v0.33.1) rather than the name of the branch (master). See the Troubleshooting section if that is not the case.

8. Check that GitHub Actions builds and deploys to PyPI. Check that the source files are available (not only the compiled files).

9. Draft a new release on GitHub (go to Code -> Releases then Draft a new release).

10. Merge master into develop.

See Package Helper for more details.

Troubleshooting

If GitHub Actions starts to deploy but fails, make sure you have valid credentials for PyPI deployment. If not, ask an owner.

If GitHub Actions fails to compile, you can check whether the version of cibuidwheel in the *.yml files is up to date.