Release Process¶
Use this checklist when cutting a new release.
Before tagging¶
- update the package version in:
pyproject.tomlengram/__init__.py- add a changelog entry in:
docs/changelog.md- update any stale tool counts, feature references, or screenshots if needed
- rebuild the docs site locally:
python -m mkdocs build- run tests:
pytest tests/ -v
Publish¶
- commit the release prep
- push
main - create a GitHub release with the matching tag, for example:
v0.5.1
Engram publishes to PyPI on release.published, not on normal pushes.
After publish¶
Verify:
- GitHub release exists
- publish workflow completed successfully
- PyPI shows the new version
- docs deployment completed if docs changed