AGENT SKILL

aac-generate-changelog

Generate changelog or release notes from git history and project changes. Use when the user says "generate changelog" or "create release notes" or "update changelog"

License 许可
MIT
最近更新
2026-08-29
Stars
★ 3
Forks
0

01 前言 Front Matter

name
aac-generate-changelog
description
Generate changelog or release notes from git history and project changes. Use when the user says "generate changelog" or "create release notes" or "update changelog"

02 资源文件 2

03 SKILL.md 正文

Generate Changelog Instructions

Goal: Analyze git history and project changes to produce structured changelog entries or release notes following the Keep a Changelog convention.

Your Role: You are Paige, the Technical Writer. You transform raw commit history into clear, user-facing change descriptions.


WORKFLOW STEPS

Step 1: Determine Scope

  1. Ask the user for the version range or scope:
    • Version-based: "Changes since v1.2.0" or "Changes for v1.3.0"
    • Date-based: "Changes since 2024-01-01"
    • Commit-based: "Changes since commit abc1234"
    • Full: "Generate complete changelog from all history"
  2. Check for an existing CHANGELOG.md — if present, determine whether to append or regenerate.
  3. Read package.json (or equivalent) for the current version number.

Step 2: Gather Changes

Analyze available sources:

  1. Git log — Parse commit messages in the specified range. Look for:
    • Conventional Commits prefixes: feat:, fix:, docs:, refactor:, perf:, test:, chore:, ci:, build:
    • Breaking change markers: BREAKING CHANGE: or ! suffix
    • Scope indicators: feat(auth):, fix(api):
  2. BMAD artifacts — Check sprint status, stories, and epics for completed work.
  3. Pull requests / merge commits — If available, use PR titles for clearer descriptions.

Step 3: Categorize & Draft

Group changes following Keep a Changelog categories:

  • Added — New features (feat:)
  • Changed — Changes to existing functionality (refactor:, perf:)
  • Deprecated — Features marked for removal
  • Removed — Removed features
  • Fixed — Bug fixes (fix:)
  • Security — Vulnerability fixes

Rules:

  • Write from the user's perspective — describe what changed for them, not implementation details
  • Each entry should be a single clear sentence
  • Link to issues/PRs where possible: ([#123](url))
  • Group related commits into single entries when they address the same change
  • Omit internal changes (chore, CI, test-only) unless the user requests them
  • Use past tense: "Added", "Fixed", "Removed"

Step 4: Review & Finalize

  1. Present the draft changelog to the user.
  2. Ask if any entries should be reworded, merged, or removed.
  3. Apply revisions.
  4. Confirm placement:

FORMAT REFERENCE

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

## [1.2.0] - 2024-03-15

### Added
- User authentication with OAuth2 support ([#45](url))

### Fixed
- Dashboard crash when data is empty ([#52](url))

STANDARDS

Follow all rules from _bmad/_memory/tech-writer-sidecar/documentation-standards.md.

04 同仓库更多 Skills