How to Release?

Creating a Release

  1. Prepare the project for a new release:

    nox -s release:prepare -- --type {major,minor,patch}

  2. Merge your Pull Request to the default branch

  3. Trigger the release:

    nox -s release:trigger

What to do if the release failed?

The release failed during pre-release checks

  1. Delete the local tag

    git tag -d "<major>.<minor>.<patch>""

  2. Delete the remote tag

    git push --delete origin "<major>.<minor>.<patch>"

  3. Fix the issue(s) which led to the failing checks

  4. Start the release process from the beginning

One of the release steps failed (Partial Release)

  1. Check the GitHub action/workflow to see which steps failed

  2. Finish or redo the failed release steps manually

Note

Example

Scenario: Publishing of the release on GitHub was successfully but during the PyPi release, the upload step was interrupted.

Solution: Manually push the package to PyPi