changelog-generator
changelog-generator analyzes your Git history and produces structured CHANGELOG.md files following Keep a Changelog standards. It parses commits using Conventional Commits conventions, automatically categorizes changes by type, detects breaking changes, and supports semantic version bumping. Use it to initialize configs, generate full histories, incrementally update unreleased sections, or publish new versions—with optional GitHub Actions integration.
changelog-generator automatically creates CHANGELOG.md files by parsing Git commit history and organizing changes by type.
AI-generated summary based on this skill's SKILL.md
Install
peterfei/ai-agent-team/changelog-generator · repository language: JavaScript
git clone https://github.com/peterfei/ai-agent-team
cp -r ai-agent-team/.claude/skills/changelog-generator ~/.claude/skills/changelog-generatornpx skillfed install peterfei/ai-agent-team/changelog-generatorFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How does changelog-generator generate changelog from git commits?
changelog-generator analyzes your Git history and produces structured CHANGELOG.md files following Keep a Changelog standards. It parses commits using Conventional Commits conventions to automatically categorize changes by type (features, fixes, breaking changes), then organizes them into version sections with proper semantic versioning.
Can changelog-generator auto create CHANGELOG.md incrementally?
Yes. changelog-generator supports incremental updates to your CHANGELOG.md. It can update the unreleased section with new commits since the last version, or publish a complete new version section when you're ready to release—without regenerating the entire history each time.
What commit message format does changelog-generator require?
changelog-generator parses commits using the Conventional Commits standard, which structures messages as type(scope): description. This allows it to automatically detect commit types (feat, fix, etc.), extract scopes, identify breaking changes marked with !, and categorize entries appropriately in your changelog.
How can I integrate changelog-generator into my CI/CD pipeline?
changelog-generator supports optional GitHub Actions integration, letting you automate changelog generation as part of your release workflow. Configure it to run on version tags or release triggers, automatically updating CHANGELOG.md and committing changes back to your repository.
Does changelog-generator detect breaking changes automatically?
Yes. changelog-generator detects breaking changes by parsing Conventional Commits markers (the ! prefix or BREAKING CHANGE footer) and categorizes them separately in your changelog. This helps readers immediately identify which updates require attention during upgrades.
What license does changelog-generator use?
changelog-generator is released under the MIT license, allowing free use, modification, and distribution in both open-source and commercial projects with minimal restrictions.
SKILL.md
rendered from the published skill — quoted content, verbatim
changelog-generator - 智能变更日志生成器
概述
当用户需要生成或更新 CHANGELOG 时,此 skill 会自动完成以下流程: 1. 分析 Git 提交历史 2. 根据 Conventional Commits 规范解析提交 3. 智能分类和组织变更 4. 生成符合 Keep a Changelog 标准的 CHANGELOG.md 5. 支持版本发布和增量更新
支持的触发指令
用户可以通过以下方式触发此 skill: - "changelog" - 简易触发词 - "变更日志" - 简易触发词 - "帮我生成 CHANGELOG" - 生成完整的 CHANGELOG - "更新 CHANGELOG" - 增量更新 CHANGELOG - "发布新版本" - 发布正式版本 - "初始化 changelog 配置" - 创建配置文件
工作流程
步骤 1: 初始化配置(首次使用)
命令:
cd ~/.claude/skills/changelog-generator
npm install
# 在项目目录中初始化配置
cd /path/to/your/project
changelog-generate init
配置文件: .changelogrc.json
交互式配置会询问: - 当前版本号 - 语言选择(中文/英文) - 是否使用 emoji - 是否显示作者信息
步骤 2: 生成 CHANGELOG
场景 A: 首次生成完整 CHANGELOG
# 生成所有历史提交的 CHANGELOG
changelog-generate generate --all
# 生成指定范围的 CHANGELOG
changelog-generate generate --from v1.0.0 --to v2.0.0
场景 B: 增量更新 CHANGELOG
# 更新 [Unreleased] 区域
changelog-generate update
# 从指定标签开始更新
changelog-generate update --from v2.0.0
场景 C: 发布新版本
```bash
自动确定版本号(交互式)
changelog-generate
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 15 files
.claude/skills/changelog-generator/.gitignore
.claude/skills/changelog-generator/.npmignore
.claude/skills/changelog-generator/CHANGELOG.md
.claude/skills/changelog-generator/LICENSE
.claude/skills/changelog-generator/README.md
.claude/skills/changelog-generator/SKILL.md
.claude/skills/changelog-generator/bin/cli.js
.claude/skills/changelog-generator/docs/PHASE2_IMPLEMENTATION_SUMMARY.md
.claude/skills/changelog-generator/examples/default-config.json
.claude/skills/changelog-generator/jest.config.js
.claude/skills/changelog-generator/package.json
.claude/skills/changelog-generator/src/core/ChangelogGenerator.js
.claude/skills/changelog-generator/src/core/CommitClassifier.js
.claude/skills/changelog-generator/src/core/GitAnalyzer.js
.claude/skills/changelog-generator/src/exporters/HTMLExporter.js