release-check

Check if project is ready for release with comprehensive pre-release validation. Use when verifying release readiness, running validation checks, or checking project quality before publishing.

⭐113stars🔀3forks📁View on GitHub🕐Updated Jan 8, 2026⬇️1downloads

When & Why to Use This Skill

The release-check skill is a comprehensive pre-release validation tool designed to ensure software projects meet all quality and compliance standards before deployment. It automates 17 critical checks—including Git status verification, dependency audits, build success, version consistency across multiple files, and documentation completeness—effectively minimizing the risk of failed releases, broken production environments, or missing metadata.

Use Cases

  • Automating the final quality gate in a CI/CD pipeline to ensure only fully validated and stable code reaches the production environment.
  • Standardizing release requirements for open-source projects to maintain high-quality documentation, licenses, and metadata compliance (e.g., HACS, npm, or Python packages).
  • Performing deep-dive consistency checks across multiple configuration files (package.json, manifest.json, const.py) to prevent version mismatch errors during deployment.
  • Scanning for sensitive data, unresolved FIXME/TODO comments, and syntax errors before public publishing to maintain professional code standards and security.
  • Validating release notes and changelogs to ensure clear communication with end-users and stakeholders before a version bump.
namerelease-check
descriptionCheck if project is ready for release with comprehensive pre-release validation. Use when verifying release readiness, running validation checks, or checking project quality before publishing.

Pre-Release Validation Checks

Run comprehensive pre-release validation checks.

Current version: Check package.json for current version.

Running Validation Checks

Execute the release check command:

npm run release:check

What Will Be Checked (17 Validations)

  1. Git status is clean
  2. On correct branch (main/master)
  3. Up to date with remote
  4. RELEASE_NOTES.md exists
  5. Dependencies installed
  6. Linting passes
  7. Type checking passes
  8. Build succeeds
  9. Version consistency across files
  10. No FIXME/TODO comments
  11. CHANGELOG.md exists
  12. Manifest.json valid
  13. HACS.json valid
  14. No sensitive data
  15. Python syntax valid
  16. README files exist
  17. LICENSE exists

Additional Pre-Release Checks

Smoke tests:

npm run test:smoke

Runs 15 critical smoke tests to ensure basic functionality.

Release notes validation:

npm run release:validate

Validates RELEASE_NOTES.md format and content.


If Checks Fail

Build Errors

  • Run: npm run build to see detailed errors
  • Fix reported issues
  • Re-run checks

Linting Errors

  • Run: npm run lint to fix automatically
  • Or: npm run lint:check to see issues
  • Fix any remaining manual issues
  • Re-run checks

Type Errors

  • Run: npm run type-check to see detailed errors
  • Fix type issues in TypeScript files
  • Re-run checks

Version Mismatch

All files should have same version:

Run appropriate bump command to sync versions.


Quick Fixes

Missing CHANGELOG.md

npm run release:changelog

Missing RELEASE_NOTES.md

npm run release:notes

Dependencies Out of Date

npm install

After All Checks Pass

Choose release type based on changes:

  • Use release-beta skill - Pre-release for community testing (recommended)
  • Use release-stable skill - Stable production release

Workflow

  1. Run validation checks
  2. Fix any reported issues
  3. Run smoke tests
  4. Validate release notes
  5. Proceed with release if all checks pass