RELEASING.md

How to Release

1. Create the release branch

# Ensure you're on `main` and are up-to-date
git checkout main
git pull

# Create the release branch
git checkout -b release/X.Y.Z

2. Update the changelog

Add a new section to the changelog, including all the unreleased changes.

## [X.Y.Z] - YYYY-MM-DD

Commit the changes:

git add CHANGELOG.md
git commit -m "Add changelog section for X.Y.Z"

3. Bump the version

# Bump the version
bump2version [major|minor|patch]

4. Push the release branch

# Push the release branch
git push -u origin release/X.Y.Z

5. Create pull request and merge

Done in GitHub UI.

6. Tag the release

# Ensure you're on `main` and are up-to-date
git checkout main
git pull

# Tag the release
git tag -s X.Y.Z -m "Release X.Y.Z"

# Push the tag
git push origin X.Y.Z

7. Update the release in GitHub

Copy the changes from the changelog for the release into the release notes in GitHub.

7. Publish to PyPI

This is done automatically using publish.yaml