Release process

This project uses tag-driven releases.

Release policy

• Versioning follows Semantic Versioning (MAJOR.MINOR.PATCH).
• Every release is tied to an immutable git tag (vX.Y.Z).
• The release workflow runs quality checks before publishing artifacts.

Maintainer checklist

1. Ensure main is green in CI.

2. Update Cargo.toml and pyproject.toml versions and CHANGELOG.md.

3. Open and merge a release preparation PR.

4. Create and push a tag from main:

   git tag -a vX.Y.Z -m "Release vX.Y.Z"
   git push origin vX.Y.Z
   

5. Verify the Release GitHub Actions workflow passes.

6. Validate uploaded artifacts and checksums from the GitHub Release page.

7. Announce the release with upgrade notes and rollback guidance.

Python package publishing (PyPI/TestPyPI)

Dumpling is configured for Python packaging via maturin (pyproject.toml). The Python distribution name is dumpling-cli, while the installed CLI command is still dumpling.

The Publish GitHub Actions workflow (.github/workflows/publish.yml) builds cross-platform wheels and an sdist, then publishes:

• Automatically to PyPI when a v*.*.* tag is pushed.
• Manually to PyPI or TestPyPI via workflow_dispatch.

Environment setup

• Configure a GitHub environment named pypi for trusted publishing.
• Optionally configure testpypi for manual pre-release validation.

Local dry-run commands

maturin build --release
maturin sdist

Rollback guidance

• If a release is faulty, create a new patch release (for example v1.2.4) that reverts or fixes the issue.
• Avoid deleting published tags; treat tags as immutable history.