Release process¶
The checklist that maintainers follow is in RELEASE_PROCESS.md. This page summarises the shape of a release and says which parts are done by hand.
Rules¶
- A release, a tag, a GitHub release and a PyPI or TestPyPI upload happen only after explicit approval by the repository owner, each time.
- History of published branches is never rewritten, and
mainis never force-pushed. - Version
1.0.0is reserved until an independent external rerun exists and a second implementation passes the conformance vectors.
Steps¶
- Sync the version in
pyproject.toml,docs/assets/badge_release.svg,specs/repo_version.yamland the changelog. - Run the checks:
uv sync --extra dev uv run ruff check src tests uv run --extra dev pytest -q -n auto uv run python scripts/gen_cli_reference.py --check uv build && uvx twine check dist/* - Build the documentation (
uv run --extra docs python scripts/build_docs_site.py, thenuv run --extra docs mkdocs build --strict). - Tag and publish through the protected workflow, after approval. PyPI publication uses Trusted Publishing from that workflow.
- Write the release notes: what changed, what is planned and not shipped, known limits.
0.6.0¶
The 0.6.0 release is planned to ship the core ledger commands, the specification and the conformance vectors,
and to make pip install protocolith available. It is not released. The packaging, publication and documentation
steps above are still to do.