release-process

Provide a step-by-step release runbook for npm publishing and tagging.

Updated Mar 18, 2022
One-click install
npx skills add https://github.com/mpaulosky/dotfiles --skill release-process-mpaulosky
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-process
Source: https://github.com/mpaulosky/dotfiles/tree/main/.copilot/skills/release-process
Command: npx skills add https://github.com/mpaulosky/dotfiles --skill release-process-mpaulosky

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This runbook eliminates accidental broken releases caused by invalid semver, incorrect NPM tokens, draft GitHub releases, and mismatched package versions by enforcing a strict, repeatable release checklist and validation flow.

Core Features & Use Cases

  • Pre-release validation: semver checks, NPM token type verification, branch cleanliness, and SKIP_BUILD_BUMP enforcement.
  • Coordinated release workflow: synchronized workspace version bumps, commit and annotated tag creation, published GitHub release requirement, and CI workflow monitoring.
  • Verification and rollback: npm publication and dist-tag verification, installation smoke tests, manual workflow_dispatch fallback, and clear rollback/unpublish or deprecate procedures.
  • Use case: Release engineers or maintainers use this to safely publish @bradygaster/squad-sdk and @bradygaster/squad-cli without risking npm mangled versions or missed publishes.

Quick Start

Use the release-process skill to guide me step-by-step to publish version 0.8.22 of @bradygaster/squad-sdk and @bradygaster/squad-cli, performing all validations, tagging, GitHub release publishing, CI monitoring, and npm verification.

Frequently Asked Questions about release-process

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

FAQPage Schema
How do I prevent npm publish failures during a CLI release?

To prevent npm publish failures during a CLI release, enforce a strict validation flow that checks semver compliance, verifies NPM tokens, and monitors CI workflows before publishing. This eliminates accidental broken releases caused by incorrect configurations.

What is npm dist-tag verification and why is it needed for releases?

Npm dist-tag verification confirms that the published package points to the correct version tag. It is needed for releases to prevent users from installing unstable or mismatched versions, ensuring the GitHub release and npm registry stay perfectly synchronized.

How do I validate semver and NPM tokens before publishing a package?

You validate semver and NPM tokens by running pre-release checks that confirm version formatting and ensure the automation token has publish permissions. This prevents invalid version bumps and unauthorized or failed npm publications during the workflow.

Can I use a manual workflow_dispatch fallback if my CI release workflow fails?

Yes, you can use a manual workflow_dispatch fallback to trigger the CI workflow if automated triggers fail. This allows you to re-run the release process and complete the npm publication and GitHub release creation manually without starting over.

What is the rollback procedure for a broken npm package release?

The rollback procedure for a broken npm package release involves unpublishing or deprecating the faulty version on npm and reverting the GitHub release tag. This corrects the registry state and protects users from installing the broken package.

Does GitHub release publishing require synchronized workspace version bumps?

Yes, GitHub release publishing requires synchronized workspace version bumps to ensure all packages share the same version. Enforcing SKIP_BUILD_BUMP rules and annotated tag creation prevents mismatched package versions and missed publishes across the monorepo.