Release Prep

Release Preparation Skill

Use this skill when preparing a new release of rhusky.

Release Workflow Overview

1. Ensure all changes are committed and tests pass
2. Bump the version
3. Push and create PR
4. After merge, CI automatically creates tag and publishes

Step 1: Pre-release Checks

Run all quality checks before releasing:

# Format check
cargo +nightly fmt --all -- --check

# Lint check
cargo +nightly clippy --all-targets --all-features -- -D warnings -W missing-docs

# Run tests
cargo test

Step 2: Check Current State

# Current version
grep '^version' Cargo.toml

# Check for uncommitted changes
git status

# Check latest git tag
git describe --tags --abbrev=0 2>/dev/null || echo "No tags yet"

Step 3: Bump Version

Choose the appropriate bump type:

• patch: Bug fixes, minor improvements (0.0.1 -> 0.0.2)
• minor: New features, backward compatible (0.1.0 -> 0.2.0)
• major: Breaking changes (1.0.0 -> 2.0.0)

1. Edit Cargo.toml and update the version field
2. Run cargo update --workspace
3. Stage and commit:

git add Cargo.toml Cargo.lock
git commit -m "chore(version): bump X.Y.Z -> A.B.C"

Step 4: Verify the Bump

# Check the commit
git log -1

# Check what files changed
git diff HEAD~1 --stat

Step 5: Push and Create PR

# Push branch
git push origin HEAD

# Create PR (if on feature branch)
gh pr create --title "chore(version): bump to X.Y.Z" --body "Release X.Y.Z"

Step 6: After Merge

Once the PR is merged to main:

1. CI runs tests (fmt, clippy, test on Linux/macOS/Windows)
2. CI detects version change (compares Cargo.toml with latest git tag)
3. CI creates git tag vX.Y.Z
4. CI generates changelog from conventional commits using Cocogitto
5. CI creates GitHub Release with changelog as release body
6. CI publishes to crates.io

This is why all commits must follow Angular Conventional Commit style (<type>(<scope>): <subject>) - Cocogitto parses these to generate the changelog automatically.

Checking Release Status

# Check latest release on GitHub
gh release list --limit 1

# Check crates.io
cargo search rhusky

Troubleshooting

CI didn't create a release

Check that:

1. The version in Cargo.toml differs from the latest git tag
2. The merge was to the main branch
3. CI workflow completed successfully

Need to re-release same version

You cannot republish the same version to crates.io. Bump to a new patch version instead.