SuperAPI AI 工具集

prepare-changelog

编程与开发

查看项目

更新于 10-16 00:30

技能介绍

用途:指导为 nextest 发布编写 changelog 条目,文档本身描述 site/src/changelog.md 的格式与约定,整体遵循 Keep a Changelog 格式并加入 nextest 特有规则。

主要能力:规定版本头写法 ## [X.Y.Z] - YYYY-MM-DD,版本号加方括号、日期用 ISO 8601;章节按 Added、Changed、Fixed、Deprecated、Removed、Security、Known issues、Miscellaneous、Internal improvements 顺序排列,只保留相关章节,用 ### 作节标题,条目用 -,子条目缩进两个空格。内容上纳入用户可见的变化、修复、性能改进、破坏性变更、MSRV 变化和安全更新;排除内部依赖更新、无用户影响的内部重构、纯站点文档改动和 CI/CD 工作流改动。写作要求简洁、用现在时、链接相关文档,并说明改动动机。

用法:通过 git log <previous-tag>..main --oneline 获取提交列表,逐条判断是否用户可见,合并相关提交;用 git log --all --author="Name" --oneline | wc -l 判断首次贡献者,用 gh pr view <number> --json author --jq '.author.login' 获取 PR 作者用户名,用 git show <commit> --stat 查看关键提交上下文。首次贡献者按 Thanks [username](https://github.com/username) for your first contribution! 致谢,回归贡献者可选择性致谢。PR 与 issue 用内联链接并在末尾定义,外部安全链接用如 CVE-xxxx。实验特性、破坏性变更、面向发行版的说明分别用标注、顶部提示和引用块处理。

适用场景:维护者为 nextest 新版本整理面向用户的发布说明。

限制:仅描述格式与流程约定,未提供自动化工具、校验命令或价格等信息。