用途
changelog-updater 用于自动更新项目中的 CHANGELOG.md,使其遵循 Keep a Changelog 格式。
触发方式
- 通过「更新 changelog」等指令触发。
- 被 git-precommit 编排器调用。 其触发关键词包括:CL、changelog、變更、版本、version、更新日誌、whatsnew。
主要能力
- 根据变更内容自动更新 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 修復。
- 输出变更预览,包含侦测到的变更列表与建议版本号。
使用方式
提供输出格式示例:先列出侦测到的变更(如 [Added] 新增用戶認證模組、[Fixed] 修復登入問題),再给出建议版本(如 0.2.0,MINOR - 新功能),最后展示 CHANGELOG 预览片段。
依据与规范
- 宪法依据:CONSTITUTION.md 第 7 条。
- 格式规范:Keep a Changelog。
适用场景
适用于需要在提交前或版本发布时自动维护变更日志、统一变更分类与版本号的项目流程。
限制
除上述功能与规则外,其余细节(如支持的平台、安装方式、是否收费等)暂未提供。