scena-release-hygiene

To automate release readiness, you must update Cargo.toml metadata, add an Unreleased section to CHANGELOG.md, validate API stability, and run cargo publish --dry-run gate checks before tagging. This enforces workflow discipline to reduce drift between code, docs, and metadata.

API stability validation is a release gate check that verifies public-facing changes are accurately documented and versioned. It ensures internal changes affecting the public API do not break existing contracts before you run dry-run publish checks.

To maintain an Unreleased section, you add notes for internal changes and public API updates directly to CHANGELOG.md. This release hygiene practice ensures unreleased notes and release gates are verified before tagging.

You need to run cargo publish --dry-run checks during public releases, internal changes affecting the public API, and documentation updates. This validates publish-readiness and enforces gate checks before tagging.

Documentation requires release discipline to ensure docs and examples stay in sync with shipped behavior. This reduces drift between code and metadata when performing documentation updates affecting the public API.