Release Check

What it does

The Release Check skill validates a project's readiness for release by examining key configurations and dependencies. It assesses the completeness of specification documents, documentation files, version numbers, and API documentation against defined requirements. The skill produces a ReleaseChecklist report detailing the status of each check, helping to identify and address potential issues before deployment.

When to use it

• Before initiating a new release cycle.
• To ensure all required artifacts (specifications, plans, tasks) are complete.
• To verify consistency in version numbers across different files.
• When API documentation needs to be validated against contract specifications.

Key capabilities

• Artifact Validation: Checks for the existence and completeness of spec.md, plan.md, and tasks.md files, as well as task completion status.
• Documentation Verification: Validates the presence and content of README.md (including a usage section) and CHANGELOG.md (including an unreleased section).
• Version Consistency: Compares version numbers in package.json and CHANGELOG.md, ensuring they match if both are present.
• API Documentation Checks: Verifies the existence of API documentation and endpoint coverage when contracts exist.
• Release Checklist Output: Generates a structured report (ReleaseChecklist) indicating overall readiness status (Ready/Not Ready) with detailed pass/fail statuses for each check.

Example prompts

• "Check if we're ready for release."
• "Run the release checklist and show me any issues."
• "Validate the release artifacts."

Tips & gotchas

• This is a manual skill, intended to be run before creating a release.
• The skill relies on specific file names (spec.md, plan.md, etc.). Ensure these files exist and are named correctly in your project.
• Version checks are optional; they only occur if both package.json and CHANGELOG.md contain version numbers.