用途
changelog-updater 用于更新项目的 CHANGELOG.md 文件,帮助维护结构化的变更记录。其触发场景包括:changelog、变更、版本、发布、改了什麼,以及被 git-precommit 自动调用。
主要能力
- 读取现有 CHANGELOG.md 内容,并获取本次改动的文件列表。
- 按 Keep a Changelog 格式维护变更日志,结构为
## [Unreleased]下分### Added/Changed/Deprecated/Removed/Fixed/Security。 - 依据关键字对变更条目进行分类:
| 类型 | 关键字 |
|---|---|
| Added | feat, 新增, add |
| Changed | change, update, 變更 |
| Deprecated | deprecate, 棄用 |
| Removed | remove, delete, 移除 |
| Fixed | fix, bug, 修復 |
| Security | security, 安全 |
- 版本号遵循 SemVer:MAJOR 对应 Breaking Changes,MINOR 对应新功能(向下相容),PATCH 对应 Bug 修复。
使用方式
该技能使用的工具包括:read_file("CHANGELOG.md")、replace_string_in_file、get_changed_files。
工作流:
- 执行
read_file("CHANGELOG.md")与get_changed_files()。 - 分类:新檔案→Added、修改→Changed/Fixed、删除→Removed。
- 更新 [Unreleased] 区块。
适用场景
适用于需要在提交前或发布前自动整理变更日志的项目,尤其是采用 Keep a Changelog 格式与 SemVer 版本规范的代码仓库。
限制
资料中未提供关于收费、价格、平台支持范围、具体效果或额外使用步骤的说明,暂未提供。