create-release-note

Create Release Note Command

功能说明

自动从 PR、commit 和 Issue 中收集变更信息，按模块和类型分类，生成符合项目格式的 Release Notes。支持创建 GitHub Draft Release。

对于 x.y.0 版本，支持合并前一 minor 系列的已发布 release notes，无需重复计算。

用法

/release-notes <version>                # 自动推断上一版本
/release-notes <version> <prev-version> # 手动指定版本范围

例如：

/create-release-note 3.6.3           # 自动推断上一版本为 3.6.2
/create-release-note 3.6.3 3.6.2     # 手动指定范围
/create-release-note 3.7.0           # x.y.0 版本：合并 3.6.x 系列的所有 release notes

参数说明

• <version>: 当前发布版本号，格式为 X.Y.Z（必需）
• <prev-version>: 上一版本号，格式为 X.Y.Z（可选，不提供则自动推断）

参数来源：$ARGUMENTS

执行步骤

步骤 1-3 为公共步骤，步骤 3 根据版本类型分流：

• 合并路径（PATCH == 0，如 3.7.0）：步骤 4-7 → 跳到步骤 14
• 常规路径（PATCH > 0，如 3.6.3）：步骤 8-13 → 继续步骤 14

步骤 14-15 为公共步骤。

步骤 1：解析参数

从 $ARGUMENTS 中提取参数。支持两种形式：

• 单参数：<version> — 当前版本号
• 双参数：<version> <prev-version> — 当前版本号和上一版本号

版本号格式验证：

• 必须匹配 X.Y.Z 格式（X、Y、Z 均为非负整数）
• 如果格式不正确，报错退出：错误：版本号格式不正确，期望格式为 X.Y.Z（例如 3.6.3）

步骤 2：确定版本范围

当前版本 tag: v<version>（如 v3.6.3）

上一版本 tag 推断逻辑（仅当未指定 <prev-version> 时）：

# 获取所有已排序的 tag
git tag --sort=-v:refname

• 如果 PATCH > 0（如 3.6.3）：查找同一 minor 系列中的前一个 tag（如 v3.6.2）
• 如果 PATCH == 0（如 3.6.0）：查找前一个 minor 系列的最后一个 tag（如 v3.5.x 中最大的）

验证 tag 存在：

git rev-parse v<version>
git rev-parse v<prev-version>

如果任一 tag 不存在，报错退出：错误：Tag v<version> 不存在，请确认 tag 已创建

步骤 3：判断版本类型并选择路径

根据版本号的 PATCH 部分选择不同的生成路径：

• 如果 PATCH == 0（如 3.7.0）→ 走合并路径，从步骤 4 开始
• 如果 PATCH > 0（如 3.6.3）→ 走常规路径，从步骤 8 开始

---

合并路径（PATCH == 0，x.y.0 版本）

步骤 4：查找前一 minor 系列的所有已发布 release

gh release list --limit 50 --json tagName,isDraft,isPrerelease

从结果中筛选满足以下条件的条目：

• tagName 以 vX.(Y-1). 开头（例如版本 3.7.0 则筛选 v3.6. 开头）
• isDraft == false
• isPrerelease == false

如果未找到任何已发布的 release，提示用户并回退到常规路径（步骤 8）。

步骤 5：按版本号升序获取各 release body

对步骤 4 筛选出的每个 release tag，按版本号升序获取其内容：

gh release view v<tag> --json body --jq .body