release-notes-generator

Release Notes Generator

打 tag 时自动对比代码变更，生成标准化的 Release Notes。

Overview

对比上一个 tag 到当前 HEAD 的 git 历史，按 conventional commit 分类（feat/fix/docs/refactor/chore），自动检测 breaking changes，生成标准化的 Release Notes。可选创建 git tag 和 GitHub Release。

When to Use

• User wants to create a tag or release
• User wants to summarize version changes
• User mentions changelog, release notes, or version documentation
• User inputs /release-notes
• User wants to generate a CHANGELOG.md from commit history
• User wants to prepare a release with categorized changes
• User wants to auto-detect breaking changes before release
• User wants to create an annotated git tag with release notes

When NOT to Use:

• User only wants to view git log
• User wants to modify existing release notes
• User wants to generate changelogs for multiple repositories (different tooling)
• User wants to automate release notes in CI/CD (consider semantic-release or release-please)

Core Pattern

Step 1: 检测版本号

获取最新 tag（git describe --tags --abbrev=0），用户指定版本号或根据变更类型建议：有 breaking changes → major，有新功能 → minor，只有 bugfix → patch。

Step 2: 对比变更

PREV_TAG=$(git describe --tags --abbrev=0)
git log ${PREV_TAG}..HEAD --oneline
git diff ${PREV_TAG}..HEAD --stat

Step 3: 分类变更

Breaking Changes 检测规则：

1. commit 消息包含 BREAKING CHANGE: 或 BREAKING CHANGES:
2. commit 类型后带 !（如 feat!:、fix!:）
3. commit body 中包含破坏性变更说明

读取 commit 消息中的 conventional commit 前缀，没有前缀的根据文件变更推断。

Step 4: 生成 Notes

使用 templates/release-notes.md 模板生成，包含版本号、日期、分类变更列表、diff 链接。

Step 5: 创建 Tag/Release（可选）

询问用户是否创建 annotated tag 和 GitHub Release。用本 skill 生成的 notes 作为 release body：

# 创建 annotated tag
git tag -a "$TAG" -m "$TAG"

# 创建 GitHub Release，使用生成的 release notes
gh release create "$TAG" --title "$TAG" --notes-file release-notes.md

Quick Reference

/release-notes              # 交互式，自动建议版本号
/release-notes v1.1.0       # 指定版本号
/release-notes --dry-run    # 只生成不创建 tag

Common Mistakes