SuperAPI AI 工具集

changelog-automation

通用与其它

查看项目

更新于 10-16 08:05

技能介绍

用途:自动化版本号提升、变更日志更新与发布说明生成,避免手工维护 CHANGELOG。

两种方案:semantic-release 基于提交(conventional commits),适合 Web 应用与单包,自动化程度高;Changesets 基于 PR 的显式变更声明,适合 npm monorepo,控制力强。默认推荐 Web 应用用 semantic-release。

语义化版本:MAJOR 破坏性变更、MINOR 向后兼容新功能、PATCH 缺陷修复。

完整基础设施由 /changelog 编排技能安装:semantic-release、commitlint + Lefthook、GitHub Actions、Gemini 3 Flash 合成用户友好说明、带 RSS 的公开 changelog 页面。

快速安装:完整方案执行 /changelog setup;仅 semantic-release 用 pnpm add -D semantic-release @semantic-release/git @semantic-release/changelog 及 pnpm add -D @commitlint/cli @commitlint/config-conventional,再配置 .releaserc.js、commitlint 与 GitHub Action;仅 Changesets 用 pnpm add -D @changesets/cli 和 pnpm changeset init,再添加 GitHub Action 并记录工作流。

最佳实践:只选一种方案;用 commitlint 强制提交格式;用 GitHub Actions 自动化;生成用户友好发布说明;打 git tag;提供公开 changelog 页面。避免手工编辑 CHANGELOG.md、跳过提交格式校验、忽略破坏性变更、无 CI 发布、发布前忘记构建、把发布说明藏在登录后。

限制:具体配置细节见 references 目录;本资料未提供价格、平台支持范围与效果数据。