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 changelog.rst and make sure it is complete and with references to issues and pull requests

3. run the test suite, try to call the program and make sure the pre-commit hook works

4. check that the documentation is building

5. Update the release date and commit the release:

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

6. Tag the release:

   git tag -a v0.X.Y -m "v0.X.Y"

7. Build source and binary wheels:

   git clean -xdf
   python -m pep517.build --source --binary .

8. Use twine to check the package build:

   twine check dist/*

9. try installing the wheel in a new environment and run the tests / binary again:

   python -m venv test
   source test/bin/activate
   python -m pip install -r dev-requirements.txt
   python -m pip install pytest
   python -m pip install dist/*.whl
   python -m pytest
   python -m blackdoc --check .; echo $?
   python -m blackdoc .; echo $?
   git reset --hard HEAD
   deactivate
   git clean -xdf

10. Push to main:

git push origin main
git push origin --tags

11. Update stable:

    git checkout stable
    git merge v0.X.Y
    git push origin stable

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

13. Draft a release on Github. Be careful, this can't be undone.

    A workflow will then publish to PyPI, which in turn will be picked up by conda-forge and a PR will be opened automatically on the feedstock.

14. Add a new section to the changelog and push directly to main