| name | changelog |
| description | 当用户想生成更新日志、写 CHANGELOG、整理版本记录时使用 — 从 Git 提交历史自动生成 CHANGELOG |
生成更新日志
从 Git 提交历史自动生成规范的 CHANGELOG。
步骤
1. 确定范围
检查是否有已有的 CHANGELOG.md 或 Git 标签。
要生成什么范围的更新日志?
- 从上次发版到现在(如果有 Git tag)
- 最近 N 次提交
- 全部历史
- 指定时间范围
2. 读取 Git 历史
获取指定范围内的所有提交记录,按类型分类:
- feat → 新功能
- fix → 修复
- docs → 文档
- refactor → 重构
- test → 测试
- chore → 其他
如果提交信息不规范,根据 diff 内容智能分类。
3. 生成 CHANGELOG
格式:
## [版本号] - 日期
### 新功能
- 功能描述
### 修复
- 修复描述
### 其他
- 变更描述
规则:
- 从用户角度描述变更("用户现在可以..."),不是从代码角度
- 合并相关的多个提交为一条记录
- 忽略纯重构、代码格式化等对用户无感的变更
4. 确认
更新日志已生成。确认后写入 CHANGELOG.md。
版本号建议:xxx(根据变更类型推荐语义化版本)