Skip to content

Latest commit

 

History

History
15 lines (14 loc) · 847 Bytes

RELEASING.md

File metadata and controls

15 lines (14 loc) · 847 Bytes
Raw

Releasing

  1. Determine the next version. Try to follow semantic versioning. Our public API is every importable Python function and class, except for antimeridian.main -- the CLI is not part of the API, and can break at any time.
  2. Create a branch named release/vX.Y.Z.
  3. Update:
    • The version in pyproject.toml
    • The CHANGELOG
    • The pre-commit hooks:
      • pre-commit autoupdate
      • Update any additional_dependencies fields to match pyproject.toml
  4. Open a PR with the changes
  5. When the PR is merged, created a tag on main with that version with a v prefix, e.g. vX.Y.Z.
  6. Push the tag to Github, which will fire off the release workflow.
  7. Create a release via the Github interface.