bmad-os-draft-changelog

Analyze commits and merged PRs to draft CHANGELOG.md entries.

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-draft-changelog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-os-draft-changelog
Source: https://github.com/bmad-code-org/BMAD-METHOD/tree/main/.claude/skills/draft-changelog
Command: npx skills add https://github.com/bmad-code-org/BMAD-METHOD --skill bmad-os-draft-changelog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzes commits and merged PRs since the last release and generates a concise CHANGELOG.md entry, ensuring release notes are ready for review without triggering a release.

Core Features & Use Cases

  • Draft changelog generation: Creates a clean, human-readable changelog entry from recent changes.
  • Release-guarded workflow: Updates CHANGELOG.md without initiating any release processes.
  • Review-ready output: Presents a draft for user confirmation before publishing.

Quick Start

Run this skill on your project root to generate a draft CHANGELOG.md entry based on commits and PRs since the latest release, ready for user review.

Frequently Asked Questions about bmad-os-draft-changelog

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

FAQPage Schema
How do I automatically generate a draft changelog from git commits and merged PRs?

You can automatically generate a draft changelog by analyzing git commits and merged PRs since your last release, then updating CHANGELOG.md with a concise entry ready for review.

Can I generate release notes without triggering the actual deployment or release process?

Yes, this workflow enforces release-guarded safety rules by drafting changelog entries and requiring user review, ensuring it never automatically triggers any deployment or release actions.

How do I compile recent features, bug fixes, and documentation changes into a single changelog entry?

Compile recent features, bug fixes, and documentation changes by analyzing commit history since your latest release, generating a clean, human-readable changelog entry for user confirmation.

Does this changelog generation workflow require manual review before updating the file?

Yes, the workflow generates a review-ready draft and requires user confirmation before updating CHANGELOG.md, ensuring you maintain control over the published release notes content.

What is the best way to prepare formal release notes for software projects from recent git history?

The best way to prepare formal release notes is to auto-draft entries from recent commits and PRs, categorizing features and fixes into a concise CHANGELOG.md update for review.