lade-release

name	lade-release
description	Prepare a Lade release: update CHANGELOG.md and bump crate versions with cargo set-version. Use when cutting a release, tagging vX.Y.Z, publishing to GitHub Releases, or finalizing the changelog before a version bump.

Lade release

Scope

Release prep touches:

• CHANGELOG.md (Keep a Changelog format)
• Crate versions via cargo set-version --workspace (lade + lade-sdk, including the path dependency)

Never commit, tag, or push — the user handles git.

Changelog workflow

1. Find the base tag

   git tag --sort=-v:refname | head -5
   git log <last-tag>..HEAD --format="%h %s"
   

2. Read [Unreleased] in CHANGELOG.md. Every user-facing item there should land in the new version section.

3. Cross-check commits since the last tag. Add anything missing from [Unreleased] (group under Added / Changed / Fixed / Removed). Skip routine chore(deps) unless security-relevant.

4. Promote [Unreleased] → [X.Y.Z] - YYYY-MM-DD

   • Use today's date for stable releases.
   • Leave an empty ## [Unreleased] section at the top.
   • Add a compare link immediately after the new section:

     [X.Y.Z]: https://github.com/zifeo/lade/compare/v<prev>...vX.Y.Z
     

   • Previous tag is usually the last stable tag on main (ignore unreleased beta tags unless the user says otherwise).

5. Writing style (match existing entries):

   • Lead with bold feature name, then PR link ([#NNN](https://github.com/zifeo/lade/pull/NNN)).
   • One line per item; explain why when behavior changes.
   • Categories: Added, Changed, Fixed, Removed (omit empty categories).

Version bump

Use cargo set-version from cargo-edit (not manual Cargo.toml edits):

cargo set-version --workspace X.Y.Z
cargo test --workspace --locked

--workspace updates lade, lade-sdk, and the lade-sdk path dependency version in one shot. Run tests (same as CI) to refresh Cargo.lock and verify the bump.

If cargo set-version is missing: cargo install cargo-edit.

GitHub release notes

Copy the new CHANGELOG.md section body (without the heading date) into the release description, or link to the compare URL.

Checklist

- [ ] `[Unreleased]` promoted to `[X.Y.Z]` with correct date
- [ ] Compare link added (`v<prev>...vX.Y.Z`)
- [ ] All commits since last tag accounted for
- [ ] `cargo set-version --workspace X.Y.Z` applied (no `-beta` left unless intentional)
- [ ] `cargo test --workspace --locked` passes