Release guide¶

Releases are automatically created from added tags using GitHub Actions.

A tag needs to be in the form of v{major}.{minor}.{patch}.

Release preparation¶

1. Create a release branch of from main branch with this pattern:

2. release/{major}.{minor}/prepare-{major}.{minor}.{patch}

3. Update CHANGELOG.md by creating a new Unreleased section and change current unreleased to release version

4. Update the latest release badge

Release¶

For a release, we use GitHub releases:

1. Create a new release
2. Set the tag
3. Set the title
4. Add a description in form of a changelog
5. Publish when ready