BMAD-METHOD/.claude/skills/draft-changelog/prompts/instructions.md

2.7 KiB

Draft Changelog Execution

⚠️ IMPORTANT - READ FIRST

This skill ONLY updates CHANGELOG.md. That is its entire purpose.

  • DO update CHANGELOG.md with the new version entry
  • DO present the draft for user review before editing
  • DO NOT trigger any GitHub release workflows
  • DO NOT run any other skills or workflows automatically
  • DO NOT make any commits

After the changelog is complete, you may suggest the user can run /release-module if they want to proceed with the actual release — but NEVER trigger it yourself.

Input

Project path (or run from project root)

Step 1: Identify Current State

  • Get the latest released tag
  • Get current version
  • Verify there are commits since the last release

Step 2: Launch Explore Agent

Use thoroughness: "very thorough" to analyze all changes since the last release tag.

Key: For each merge commit, look up the merged PR/issue that was closed.

  • Use gh pr view or git commit body to find the PR number
  • Read the PR description and comments to understand full context
  • Don't rely solely on commit merge messages - they lack context

Analyze:

  1. All merges/commits since the last tag
  2. For each merge, read the original PR/issue that was closed
  3. Files changed with statistics
  4. Categorize changes:
    • 🎁 Features - New functionality, new agents, new workflows
    • 🐛 Bug Fixes - Fixed bugs, corrected issues
    • ♻️ Refactoring - Code improvements, reorganization
    • 📚 Documentation - Docs updates, README changes
    • 🔧 Maintenance - Dependency updates, tooling, infrastructure
    • 💥 Breaking Changes - Changes that may affect users

Provide:

  • Comprehensive summary of ALL changes with PR context
  • Categorization of each change
  • Identification of breaking changes
  • Significance assessment (major/minor/trivial)

Step 3: Generate Draft Changelog

Format:

## v0.X.X - [Date]

* [Change 1 - categorized by type]
* [Change 2]

Guidelines:

  • Present tense ("Fix bug" not "Fixed bug")
  • Most significant changes first
  • Group related changes
  • Clear, concise language
  • For breaking changes, clearly indicate impact

Step 4: Present Draft & Update CHANGELOG.md

Show the draft with current version, last tag, commit count, and options to edit/retry.

When user accepts:

  1. Update CHANGELOG.md with the new entry (insert at top, after # Changelog header)
  2. STOP. That's it. You're done.

You may optionally suggest: "When ready, you can run /release-module to create the actual release."

DO NOT:

  • Trigger any GitHub workflows
  • Run any other skills
  • Make any commits
  • Do anything beyond updating CHANGELOG.md