How to Release?

  1. Use nox -s release:prepare to prepare the project for a new release.

  2. Merge your Pull Request to the default branch

  3. Use git remote show origin | sed -n '/HEAD branch/s/.*: //p' to output the default branch

  4. Use git checkout <default branch> Switch to the default branch

  5. Use git pull to update branch

  6. Use TAG=<name> to set a variable named “TAG”

  7. Use git tag "${TAG}" to create a new tag in your repo

  8. Use git push origin "${TAG}" to push it to remote

  9. GitHub workflow CD reacts on this tag and starts the release process