SuperAPI AI 工具集

release-notes

写作与研究

查看项目

更新于 10-15 20:14

技能介绍

用途:为 Hive 的 CLI(cmd/hive)或桌面端(cmd/desktop)撰写发布说明片段。用户可见的改动需在对应程序的 changelog 中新增一条片段,随该改动的 PR 一起提交。两个程序共用同一版本号发布,桌面端内嵌 changelog 并在应用内展示草稿,CLI 的说明随 GitHub Release 发布。

主要能力:判断改动是否值得写说明;复用或新建片段;按 added、changed、fixed 分类;生成片段文件并校验。

使用方式:先用 git diff main...HEAD --stat 与 git log main..HEAD 查看改动;用 ls 查看 unreleased 目录已有片段;新建片段执行 mise run changelog:new -- --product desktop --kind added "说明文字",--product 取 cli 或 desktop,--kind 取 added、changed、fixed;多行内容用 stdin 传入。命令会打印写入路径,可回读修改正文或分类。校验运行 go test ./cmd/hive/releasenotes/... ./cmd/desktop/releasenotes/...。

写作要求:一条片段一个要点,加粗开头,现在时、面向用户描述应用行为;指明用户可找到的界面与配置键;changed 说明用户需如何调整,fixed 描述症状而非原因;未完成区域标注 experimental;不得提及 Go 包、Vue 组件、ADR、issue 或 PR 编号;不写发布摘要。

限制:每个改动一个文件,不得手工创建或合并两个分支的片段;不得在功能分支写 changelog/<version>.md,预发布版本名会在解析时被拒绝;重构、测试、CI、文档、无可见影响的依赖升级不写说明。