Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 948 Bytes

File metadata and controls

43 lines (31 loc) · 948 Bytes

Release Guide

Releasing a New Version

To release a new version to PyPI:

  1. Bump the version number in pyproject.toml:

    version = "0.x.y"
  2. Commit the change:

    git commit -am "Bump version to 0.x.y"
  3. Tag the release and push:

    git tag v0.x.y
    git push origin v0.x.y

This will trigger the GitHub Actions workflow to build and publish the package to PyPI using uv publish.

Package Information

Version Management

The project uses semantic versioning:

  • 0.x.y-alpha.z for alpha releases
  • 0.x.y for stable releases
  • x.y.z for major releases

Automated Publishing

The GitHub Actions workflow automatically:

  • Builds the package using hatchling
  • Runs tests and linting
  • Publishes to PyPI when a tag is pushed