SuperAPI AI 工具集

changelog-gen

通用与其它

查看项目

更新于 10-16 06:15

技能介绍

用途:根据 git 历史自动生成变更日志,减少手工整理提交信息的重复劳动,适合准备发布说明、补齐遗漏的 CHANGELOG 或统一各版本格式。

主要能力:读取任意两个 ref(标签、分支、提交)之间的 git log;将提交归入 Added、Changed、Fixed、Removed 四类;把杂乱的提交信息整理为可读条目;输出可直接写入 CHANGELOG.md 的 Markdown。

使用方式:无需安装,直接用 npx 运行。常用命令:npx ai-changelog --from v1.0.0 --to v2.0.0;npx ai-changelog --from v1.0.0 --to HEAD;npx ai-changelog --from v1.0.0 --to v2.0.0 -o CHANGELOG.md;npx ai-changelog --from abc123 --to def456。查看帮助:npx ai-changelog --help。

工作原理:在指定 ref 之间运行 git log,收集提交信息并发送给 GPT-4o-mini,由模型解析每条变更并格式化为 Keep a Changelog 风格。

适用场景:发布前生成变更条目;补写未维护的变更日志;为 GitHub Release 生成发布说明;保持跨版本格式一致。

限制与要求:需要 Node.js 18+ 及 OPENAI_API_KEY 环境变量;输出由 AI 生成,可能对部分变更分类有误,建议人工复核;提交信息质量会影响结果。采用 MIT 许可,免费使用。

建议实践:为发布打标签、编写清晰的提交信息、发布前运行并检查输出。