Releasing¶
Maintainer notes for cutting a new release.
Checklist¶
1. Version bump¶
- Version is derived from git tags via
hatch-vcs(no manual edit inpyproject.toml) - Update
versionanddate-releasedinCITATION.cff - Update version header in
docs/explanation/compatibility-matrix.md
2. Changelog¶
- Add a new
## vX.Y.Zsection todocs/changelog.md - Summarize highlights, stability changes, and breaking changes
3. Lint and format¶
4. Unit tests¶
5. Live smoke tests (network)¶
Network tests are excluded by default. Run them locally when you're about to cut a release:
To require that all live checks run (fail if any network test is skipped):
6. Docs build¶
Check for warnings and broken links.
7. Build artifacts¶
Verify both sdist and wheel are produced.