SuperAPI AI 工具集

release-notes

通用与其它

查看项目

更新于 10-15 21:42

技能介绍

用途:为生产发布从 git 提交自动生成发布说明,支持三种输出格式。

主要能力:扫描上个发布标签以来的提交;通过 gh api 获取 PR 标题与描述;按提交前缀归类(feat、fix、perf、security 等);检测数据库迁移文件并给出迁移提醒;生成 CHANGELOG.md 段落、PR 发布正文(使用项目发布模板)和面向用户的沟通公告(Slack、邮件等);将技术术语转换为产品语言;依据语义化版本规则判断版本号(破坏性变更 MAJOR、新功能 MINOR、修复 PATCH);统计 PR、功能、修复与变更文件数。

使用方式:在仓库根目录运行 /release-notes,可指定版本(如 /release-notes v1.5.0)、范围(from v1.4.0 to HEAD)、--preview 预览或 --include-pre-release。核心命令包括 git tag --sort=-v:refname 取最近标签、git log $LAST_TAG..HEAD --oneline --no-merges 列提交、git diff 检测迁移目录、gh api 取 PR 详情。合并后创建并推送标签:git tag -a v1.2.3 -m "Release v1.2.3: Brief description" 与 git push origin v1.2.3。

适用场景:需要规范化发布流程、同时产出内部变更日志与对外公告的项目。

限制:需在仓库根目录运行并认证 GitHub CLI(gh auth login);迁移检测路径需按 ORM 调整;生成内容需人工复核后再发布;无标签时从首个提交开始,无新提交时报错,非规范格式提交归入 Other Changes;预发布标签会被排除。模板文件位置与项目配置相关,资料未提供具体默认值。