用途
changelog-updater 用于根据变更内容自动更新 CHANGELOG.md,并遵循 Keep a Changelog 格式。它适合在需要维护版本变更记录、生成或整理发布说明的场景中使用。
主要能力
- 自动更新 CHANGELOG.md。
- 依变更内容进行类型分类,分类规则基于关键字侦测:
- Added:新增、add、feat
- Changed:变更、修改、update、change
- Deprecated:棄用、deprecate
- Removed:移除、刪除、remove、delete
- Fixed:修復、fix、bug
- Security:安全、security、漏洞
- 决定版本号,采用 MAJOR.MINOR.PATCH:
- MAJOR:重大变更新(Breaking Changes)
- MINOR:新功能(向下相容)
- PATCH:Bug 修復
- 输出格式包含:检测到的变更列表、建议版本及理由、预览的 CHANGELOG 段落。
使用方式
触发条件包括:
- 使用者提及「changelog」「version」「release notes」「更新日誌」「版本」等关键词。
- 被 git-precommit 编排器调用。
输出示例结构:
📋 CHANGELOG 更新
偵測到的變更:
- [Added] 新增用戶認證模組
- [Fixed] 修復登入問題
建議版本:0.2.0 (MINOR - 新功能)
預覽:
[0.2.0] - 2025-12-15
Added
- 新增用戶認證模組
Fixed
- 修復登入問題
适用场景
- 专案中需要维持结构化的变更日志时。
- 提交前流程(通过 git-precommit 编排器)需要自动产生或更新 CHANGELOG 时。
- 需要依据变更内容建议版本号时。
限制
- 技能声明依据宪法 CONSTITUTION.md 第 7 条及 Keep a Changelog 格式,相关细节暂未提供。
- 除上述触发条件、分类规则与版本号规则外,其余实现细节暂未提供。