Smaqit Release Prepare Files

Release Prepare Files

Validate the repository state and prepare all necessary files for a release, including CHANGELOG.md and optional version files.

When to use this skill

Use this skill after obtaining version approval and before executing git operations to:

• Validate git working tree is clean
• Verify correct branch
• Finalize CHANGELOG.md with approved version
• Optionally sync version files (package.json, etc.)

How to execute

Step 1: Validate Git State

A. Verify current branch:

git branch --show-current

• For local releases: Should be main or user-specified release branch
• For PR-based releases: Feature branch is acceptable
• If not on main (local release): Warn and request confirmation

B. Check version doesn't exist in CHANGELOG.md:

grep "## \\[X.Y.Z\\]" CHANGELOG.md

• Replace X.Y.Z with actual version (e.g., grep "## \\[0.3.0\\]" CHANGELOG.md)
• If version already exists: Stop and report "Version X.Y.Z already exists in CHANGELOG.md"

Note: Uncommitted changes are acceptable - they will be handled during git operations step.

Step 2: Finalize CHANGELOG.md

A. Move Unreleased content to new version section:

Find the ## [Unreleased] section and move its content to a new version section with current date (YYYY-MM-DD):

## [Unreleased]

(empty or minimal content)

## [X.Y.Z] - YYYY-MM-DD
### Added
- Feature X

### Fixed
- Bug Y

B. Update comparison links at bottom of CHANGELOG.md:

Update the link structure:

[Unreleased]: https://github.com/owner/repo/compare/vX.Y.Z...HEAD
[X.Y.Z]: https://github.com/owner/repo/releases/tag/vX.Y.Z
[Previous]: https://github.com/owner/repo/releases/tag/vPrevious

C. If creating CHANGELOG.md from scratch:

Use Keep a Changelog format:

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [X.Y.Z] - YYYY-MM-DD
### Added
- Initial release

[Unreleased]: https://github.com/owner/repo/compare/vX.Y.Z...HEAD
[X.Y.Z]: https://github.com/owner/repo/releases/tag/vX.Y.Z

Step 3: Optionally Sync Version Files

A. Ask user for version files:

Common version files by ecosystem:

• JavaScript/Node.js: package.json
• Python: pyproject.toml, setup.py, __init__.py
• Rust: Cargo.toml
• Go: Version constant in main package
• Ruby: Gemspec or version.rb

B. If repository has obvious version file:

• Propose it and ask for confirmation
• Example: "I found package.json with version field. Update it to X.Y.Z?"

C. If user confirms version files:

1. Update version strings in each file
2. Important: Remove 'v' prefix for version files (use X.Y.Z, not vX.Y.Z)
3. Verify consistency across all files

Example updates:

package.json:

{
  "version": "0.3.0"
}

pyproject.toml:

[project]
version = "0.3.0"

D. If user declines or no version files exist:

• Skip this step
• Only CHANGELOG.md will be modified

Step 4: Verify All Changes

Before completing:

1. Confirm CHANGELOG.md has new version section
2. Confirm CHANGELOG.md comparison links are updated
3. Confirm version files (if any) have consistent versions
4. List all files that will be committed

Output

Provide a summary of files prepared:

files_modified:
  - CHANGELOG.md
  - package.json
validation_passed: true
version_synced: true

Output fields:

• files_modified: List of files changed during preparation
• validation_passed: Boolean indicating all validations passed
• version_synced: Boolean indicating if version files were updated

Error Handling

Notes

• This skill modifies files but does NOT commit them (git operations are separate)

• All file modifications are reversible with git checkout

• Version files are optional - CHANGELOG.md is the only required file

• Keep a Changelog format uses version WITHOUT 'v' prefix in headers (e.g., ## [0.3.0]), but git tags use 'v' prefix (e.g., v0.3.0)

• For PR-based releases, validation rules are slightly relaxed (feature branch OK)

• Uncommitted changes in working tree are acceptable - release-git-local handles commit grouping

Converted and distributed by TomeVault — claim your Tome and manage your conversions.