Skip to content

Steps for creating a new release

  1. Create a release on GitHub with a short release description.

    Ensure you add a # <version number> title to the description.

    Set the tag to the version number prefixed with "v" and title to the version number as explained above.

  2. Ensure the GitHub Action CD workflows run as expected.

The workflow failed

If something is wrong and the workflow fails before publishing the package to PyPI, make sure to remove all traces of the release and tag, fix the bug, and try again.

If something is wrong and the workflow fails after publishing the package to PyPI: DO NOT REMOVE THE RELEASE OR TAG !

Deployment of the documentation should (in theory) be the only thing that has failed. This can be deployed manually using similar steps as in the workflow.