Release Process

This project uses:

  • uv for local development and builds.

  • Python Semantic Release for versioning and GitHub releases.

  • PyPI Trusted Publishing from GitHub Actions.

  • Read the Docs GitHub App integration for documentation builds.

Versioning

The project starts in 0.x and allows zero-version releases. Conventional commits drive version bumps through Python Semantic Release.

Publishing

The release workflow runs on pushes to main. When Python Semantic Release creates a new release, GitHub Actions builds the package with uv build and publishes the distribution to PyPI using trusted publishing.

Read the Docs

Read the Docs should be connected through the GitHub App integration. The .readthedocs.yaml file points RTD at docs/source/conf.py and installs the package with its documentation dependencies.