HOW_TO_RELEASE.rst

Release process

1. the release happens from main so make sure it is up-to-date:

   git pull origin main

2. look at whats-new.rst and make sure it is complete and with references to issues and pull requests

3. open and merge a pull request with these changes

4. make sure the CI on main pass

5. check that the documentation build on readthedocs completed successfully

6. Fill in the release date and commit the release:

   git commit -am "Release v0.X.Y"

7. Tag the release and push to main:

   git tag -a v0.X.Y -m "v0.X.Y"
   git push origin --tags

8. Draft a release for the new tag on github. A CI will pick that up, build the project and push to PyPI. Be careful, this can't be undone.

9. Make sure readthedocs builds both stable and the new tag

10. Add a new section to whats-new.rst and push directly to main