Skip to content

Release Process

Use this checklist when cutting a new release.

Before tagging

  1. update the package version in:
  2. pyproject.toml
  3. engram/__init__.py
  4. add a changelog entry in:
  5. docs/changelog.md
  6. update any stale tool counts, feature references, or screenshots if needed
  7. rebuild the docs site locally:
  8. python -m mkdocs build
  9. run tests:
  10. pytest tests/ -v

Publish

  1. commit the release prep
  2. push main
  3. create a GitHub release with the matching tag, for example:
  4. 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