release-prep

Bump package versions, draft CHANGELOG, and print a git tag command.

19|31|Updated May 29, 2025
One-click install
npx skills add https://github.com/grafana/grafana-pathfinder-app --skill release-prep-grafana
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-prep
Source: https://github.com/grafana/grafana-pathfinder-app/tree/main/.cursor/skills/release-prep
Command: npx skills add https://github.com/grafana/grafana-pathfinder-app --skill release-prep-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Orchestrates the pre-release flow for grafana-pathfinder-app — bump the version in package.json, refresh package-lock.json, draft a CHANGELOG entry via the changelog skill, run checks and builds, and present the exact git tag command for the user to run (without pushing any tags).

Core Features & Use Cases

  • Version bump orchestration: updates package.json and package-lock.json deterministically to synchronize release state.
  • CHANGELOG drafting: delegates to the changelog skill to generate a CHANGELOG entry.
  • Validation & checks: runs npm run check and npm run build; aborts if failures.
  • Tag command presentation: prints the exact git tag command; does not push tags or commits.
  • Safety constraints: ensures a clean working tree and on-main alignment before releasing.

Quick Start

Run /release-prep to begin the pre-release workflow and review the proposed release steps.

Frequently Asked Questions about release-prep

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate a pre-release workflow with version bumps and changelog updates?

Pre-release workflow automation coordinates version bumps in package.json and package-lock.json, drafts CHANGELOG entries, runs validation checks, and prepares git tag commands. It operates in phases to ensure release safety without automatically pushing commits or tags to the repository.

What happens if npm run check or npm run build fails during the release preparation process?

Release preparation aborts immediately if npm run check or npm run build fails during validation. This safety constraint prevents progressing with a release when checks are not passing, ensuring only validated code proceeds to the tagging stage.

Can I use this release workflow if my git working tree has uncommitted changes?

Release workflows require a clean working tree and on-main branch alignment before proceeding. The process aborts if the working tree is dirty, ensuring release safety constraints are met before any version bump or CHANGELOG drafting occurs.

Does the pre-release automation push git tags and commits automatically to the repository?

Pre-release automation never pushes commits or tags automatically. It prints the exact git tag command for the user to execute manually, maintaining control over the remote repository state while still orchestrating the version bump and CHANGELOG updates locally.

What's the best way to draft a CHANGELOG entry during an npm package release?

Drafting a CHANGELOG entry during npm package release is handled by delegating to a dedicated changelog skill within the workflow. This ensures the entry is generated consistently as part of the version bump and validation phases before the tag command is presented.

Why does the release workflow operate in distinct phases instead of running all steps at once?

Operating in distinct phases allows the release workflow to enforce safety constraints at each step, aborting on failed checks or dirty working trees before proceeding. This phased approach prevents incomplete or invalid releases by validating each stage before presenting the final git tag command.