用途:changelog 是一个命令行工具,用于按 Keep a Changelog 格式维护项目的 CHANGELOG.md 文件,适合在处理变更日志文件、添加条目时使用。
主要能力:添加条目(changelog add --type <TYPE> <DESCRIPTION>);支持类型 added(a)、changed(c)、deprecated(d)、removed(r)、fixed(f)、security(s);可将条目加入指定版本,如 changelog add --type fixed --version 1.0.1 "critical security patch"。发布版本支持自动语义化递增(changelog release major/minor/patch)、显式版本(changelog release 1.0.0)以及自定义日期(--date 2025-01-01)。还可交互式审阅 git 提交并加入变更日志(changelog review),带 feat:、fix: 等约定式提交前缀的提交会被预选。版本信息命令:changelog version latest、version list、version range 1.0.0。其他命令:changelog entry 1.0.0/latest/unreleased 查看条目,changelog fmt 格式化,changelog init 初始化,changelog completions bash|zsh|fish 生成补全。
使用方式与风格:条目描述建议使用现在时描述新行为(如 X now supports Y),移除或修复用过去时(Fixed X);描述状态而非命令;除专有名词外使用小写。示例:changelog add --type added "commands now accept multiple arguments"。当该 CLI 可用时,不要手动编辑 CHANGELOG.md,应通过 changelog add 以程序化方式添加条目,以保证格式与结构正确。
适用场景:需要规范化维护版本发布记录的项目,尤其是使用语义化版本和约定式提交的仓库。
限制:资料未提供安装方法、依赖要求、支持平台、许可或价格等信息;具体编辑器行为等细节暂未提供。