Release ProcessΒΆ

  1. Checkout the current main branch.

  2. Install the latest nox:

    $ pip install nox

  3. Manually update the changelog to list all unreleased changes. Also verify that no new changes were added to a previous release in an earlier PR due to merge/rebase issues.

  4. Run the release automation with the required version number (YY.N):

    $ nox -s release -- YY.N

    You will need the password for your GPG key as well as an API token for PyPI.

  5. Add a release on GitHub.

  6. Notify the other project owners of the release.

Note

Access needed for making the release are:

  • PyPI maintainer (or owner) access to packaging

  • push directly to the main branch on the source repository

  • push tags directly to the source repository