release

Release

Turn the Conventional Commits since the last tag into a versioned release (CHANGELOG.md from git-cliff, manifest bumps, an annotated tag, a GitHub release), then prove what was published; conventional-commit owns the commit grammar git-cliff parses.

Workflow

1. Check the preconditions:

   • Clean working tree on main, synced with origin.
   • The proposed tag is absent locally and remotely; stop if either copy exists and never move a published tag.
   • A repository workflow that owns release creation runs from the pushed tag; verify its result instead of publishing a second release from the CLI.

2. Gate: Run the full gate (mise run all); if the tree carries unrelated changes and the gate write-formats, run it in a temporary git worktree or fall back to mise run check and mise run test (see mise).

3. Compute the next version from the commit types since the last tag: feat → minor, fix and others → patch, ! or BREAKING CHANGE → major:

   git-cliff --bumped-version
   

4. Bump manifests that are not VCS-versioned: Python version in pyproject.toml (unless hatch-vcs or similar), Node npm version --no-git-tag-version X.Y.Z; Go and OpenTofu need no file change.

5. Generate the changelog for that version:

   git-cliff --bump -o CHANGELOG.md
   

6. Commit the release; the chore(release) subject is excluded from the changelog by design:

   git add CHANGELOG.md   # plus the manifest bumped above, if any
   git commit -m "chore(release): vX.Y.Z"
   

7. Tag and push the exact release commit atomically:

   tag=vX.Y.Z
   release_sha=$(git rev-parse HEAD)
   git tag -a "$tag" -m "$tag" "$release_sha"
   git push --atomic origin main "refs/tags/$tag"
   

8. Publish with the latest changelog section as notes, written to a temporary file to stay shell-agnostic:

   release_tmp=$(mktemp -d)
   git-cliff --latest --strip all > "$release_tmp/release-notes.md"
   gh release create "$tag" --verify-tag --title "$tag" --notes-file "$release_tmp/release-notes.md"