概述
发布时手工回忆并撰写变更日志,容易遗漏且措辞随意。让贡献者在改动时即记录说明,发布时据此生成草稿再人工润色,并把破坏性变更与迁移步骤置顶,可让消费方第一时间看到真正影响他们的内容。
关键步骤
- 要求贡献者随改动添加变更说明。
- 发布时由说明生成变更日志。
- 突出破坏性变更与迁移步骤。
- 条目链接到 issue 或 PR。
验证
- 生成的日志覆盖本次全部面向用户的变更。
- 破坏性变更包含迁移指引。
- 条目可追溯到来源。
- 日志已发布并打标签。
决策点
宜自动生成草稿再人工编辑以提升可读性;只应列入面向用户的变更与重要修复,罗列内部重构会淹没重点。
适用范围
本条目围绕「变更日志自动化工作流」给出可复制的步骤、验证方式与常见问题,适合需要按此流程落地的工程团队。执行时请结合自身上下文调整命令与阈值,并在变更前后留存证据,便于后续复核与回滚。
建议在正式环境落地前先在预发或隔离环境演练一遍,把关键观测指标与负责人一并记录,确保出现异常时能快速定位并恢复。
npx conventional-changelog -p angular -i CHANGELOG.md -s
# review and edit before publishing