bmad-os-release-module

Automates npm release process including changelog drafting, versioning, git tagging, publishing, and GitHub releases.

51.7k|5.9k|Updated Apr 13, 2025
One-click install
npx skills add https://github.com/bmad-code-org/BMAD-METHOD --skill bmad-os-release-module
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-os-release-module
Source: https://github.com/bmad-code-org/BMAD-METHOD/tree/main/.claude/skills/release-module
Command: npx skills add https://github.com/bmad-code-org/BMAD-METHOD --skill bmad-os-release-module

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the end-to-end npm release process to reduce manual toil and human error.

Core Features & Use Cases

  • Automates changelog drafting, version bumps, git tagging, npm publishing, and GitHub releases.
  • Validates project state and prompts for changelog entry to ensure release readiness.
  • Supports standard npm release workflows for libraries published to npm and GitHub.

Quick Start

From the project root, run the release-module skill to automate an npm release.

Frequently Asked Questions about bmad-os-release-module

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

FAQPage Schema
How do I automate npm module releases end-to-end?

You can automate the npm module release process by coordinating changelog drafting, version bumps, git tagging, npm publishing, and GitHub release creation in a single workflow to reduce manual toil and human error.

What is the best way to automate version bumps and changelog updates for npm packages?

Automating version bumps and changelog updates involves validating the project state, prompting for changelog entries to ensure release readiness, and then applying standard npm versioning practices alongside git tag creation.

Can I publish to npm and create a GitHub release in one step?

Yes, you can coordinate npm publishing and GitHub release creation in one automated step, ensuring that your published npm library version matches the corresponding GitHub release and git tag.

Do I need to draft a changelog before running an automated npm publish?

Yes, drafting a changelog entry is required before publishing; the automation validates your project state and prompts for a changelog entry to ensure your library is fully ready for release.

Does this automated release workflow support standard npm libraries published to GitHub?

Yes, this workflow applies to projects that publish libraries to npm and follow changelog-driven release cycles, covering standard npm release practices for repositories hosted on GitHub.

What happens if my project state is not ready for an npm version bump?

If your project state is not ready, the release automation validates the repository and prompts you to resolve missing changelog entries or other release readiness requirements before proceeding with the version bump.