changelog-automation 指导 AI 从提交、PR 和版本记录整理更新说明,并建立便于持续生成的提交约定。适合维护软件发布的人:提供本次版本范围与改动记录,让 AI 把变化转成用户和升级者能读懂的说明。
最需要留意的是不兼容变化。比如接口把 id 改成 userId,这不能只藏在“优化接口”里。原文用明确的破坏性变更标记和说明,提醒生成流程保留影响与迁移方式。
提交内容越清楚,后续整理越可靠。功能、修复和改动范围应该表达具体,一次提交尽量对应一件逻辑完整的事情,也可以关联问题单。否则一串“update”“fix”很难自动还原成可信的发布说明。
原文展示了版本摘要、重要变化、升级指南和已知问题等信息。里面的性能提升数字是示例,实际稿件只能使用这次改动中能核对的证据。
这份 Skill 适合把发版前翻记录的工作变得有规律。生成后仍应审阅遗漏和措辞,尤其是接口兼容性与升级动作;发布说明写好了,也不代表版本已经对外发布。