Skip to content

MAINTAINING.md

Latest commit

 

History

History
17 lines (12 loc) · 1.21 KB

MAINTAINING.md

File metadata and controls

17 lines (12 loc) · 1.21 KB
Raw

Maintenance instructions

These notes are for maintenance of the Git / PyPI source and releases, rather than the client library - if you are not a maintainer, you can skip this doc!

Release tasks

All the tasks we need to do, in order, when releasing a new version:

    • Check the main branch — confirm all intended changes are merged and CI is green.
    • Update project.version in pyproject.toml — note the new version number.
    • Update CHANGELOG.md — move the new version to the top, add the release date and future PyPI URL, and summarize user-visible changes.
    • Install release tools — run python -m pip install ".[release]".
    • Run tests and checks — run python -m pytest tests/ -v and pre-commit run --all-files.
    • Commit and push release preparation — use a message such as Prepare release 0.2.0, then confirm CI remains green.
    • Run ./publish.sh — it clears old artifacts, builds the sdist and wheel from pyproject.toml, validates them with Twine, and uploads them to PyPI. Twine prompts for credentials when needed.

The publish script derives artifact names from the build output, so it does not need a version-specific edit.