manuelmauro/skilo/prepare-release

Prepare Release

Steps to prepare a new skilo release.

Checklist

1. All tests pass
2. No Clippy warnings
3. Update version in Cargo.toml
4. Update Cargo.lock
5. Update CHANGELOG.md
6. Update the supported versions table in .github/SECURITY.md
7. Find and update version references in docs
8. Commit changes (including Cargo.lock)
9. Create git tag

Version Bump

Update version in Cargo.toml:

[package]
version = "X.Y.Z"

After updating Cargo.toml, run cargo check to update Cargo.lock:

cargo check

Changelog Format

Follow Keep a Changelog format:

## [X.Y.Z] - YYYY-MM-DD
 
### Added
-New features
 
### Changed
-Changes to existing functionality
 
### Fixed
-Bug fixes

Update Version References in Docs

Search for hardcoded version numbers in documentation and update them:

# Find version references (e.g., skilo@0.3.0, v0.3.0)
rg "skilo@\d+\.\d+\.\d+" --type md
rg "v\d+\.\d+\.\d+" README.md

Common locations:

• README.md - CI example (cargo install skilo@X.Y.Z)
• Installation instructions
• Badge URLs

Update Supported Versions in SECURITY.md

.github/SECURITY.md declares which release series receives security fixes. Bump its Supported Versions table so the new minor series is marked supported and any series that is no longer maintained is dropped:

| Version | Supported          |
| ------- | ------------------ |
| 0.11.x  | :white_check_mark: |
| < 0.11  | :x:                |

Release Commands

# Verify everything passes
cargo test && cargo clippy
 
# Commit release changes
git add -A
git commit -m "chore: release vX.Y.Z"
 
# Create annotated tag
git tag -a vX.Y.Z -m "Release vX.Y.Z"
 
# Push with tags
git push && git push --tags

Publishing to crates.io

# Dry run first
cargo publish --dry-run
 
# Publish
cargo publish