关于 release-skills
Release Skills 是适用于多种项目的通用发布工作流技能,支持 Node.js、Python、Rust 和 Claude Plugin 项目。它可识别版本与变更日志文件、生成多语言发布说明、更新版本,并支持项目专用钩子。
主要功能
- 01识别支持的项目版本文件
- 02查找并识别变更日志语言
- 03根据变更确定版本升级
- 04生成本地化变更日志条目
- 05支持试运行和发布钩子
适用场景
- 01为支持的项目类型准备发布
- 02生成多语言变更日志
- 03通过试运行预览发布改动
- 04用钩子委托打包和发布
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ jimliu/ baoyu-skills --skill release-skills安装后在 Claude Code 中输入/release-skills确认已加载。
详细介绍
发布技能
通用发布工作流,支持任何类型的项目和多语言变更日志。
用户输入工具
当此技能向用户提问时,请遵循以下工具选择规则(按优先级排序):
- 优先使用当前 Agent 运行时提供的内置用户输入工具,例如
AskUserQuestion、request_user_input、clarify、ask_user或任何同等工具。 - 备用方案:如果没有此类工具,则输出带编号的纯文本消息,并请用户针对每个问题回复选定的编号或答案。
- 批量提问:如果工具支持在一次调用中提出多个问题,请将所有适用问题合并到一次调用中;如果工具每次只能提出一个问题,则按优先级逐一提问。
下方的 AskUserQuestion 引用仅为示例 — 在其他运行时中,请替换为本地同等工具。
快速开始
只需运行 /release-skills — 系统会自动检测项目配置。
支持的项目
| 项目类型 | 版本文件 | 自动检测 |
|---|---|---|
| Node.js | package.json | ✓ |
| Python | pyproject.toml | ✓ |
| Rust | Cargo.toml | ✓ |
| Claude 插件 | marketplace.json | ✓ |
| 通用 | VERSION / version.txt | ✓ |
选项
| 标志 | 说明 |
|---|---|
--dry-run | 预览更改,但不执行 |
--major | 强制升级主版本号 |
--minor | 强制升级次版本号 |
--patch | 强制升级修订版本号 |
--backfill-releases | 根据变更日志章节,为现有标签创建缺失的 GitHub Releases |
工作流
第 1 步:检测项目配置
- 检查是否存在
.releaserc.yml(可选配置覆盖)- 如果存在,检查其中是否定义了发布钩子
- 按以下优先级扫描并自动检测版本文件:
package.json(Node.js)pyproject.toml(Python)Cargo.toml(Rust)marketplace.json或.claude-plugin/marketplace.json(Claude Plugin)VERSION或version.txt(通用)
- 使用 glob 模式扫描变更日志文件:
CHANGELOG*.mdHISTORY*.mdCHANGES*.md
- 根据文件名后缀识别每个变更日志的语言
- 检测 GitHub 发布支持情况:
- 检查
origin是否指向 GitHub - 检查是否已安装并通过身份验证的
gh - 如果可用,使用
gh release list --limit 5检查现有发布
- 检查
- 显示检测到的配置
项目钩子约定:
如果 .releaserc.yml 定义了 release.hooks,则保持发布工作流通用,并将项目专属的打包/发布操作委托给这些钩子。
支持的钩子:
| 钩子 | 用途 | 预期职责 |
|---|---|---|
prepare_artifact | 使一个目标可发布 | 验证目标是否自包含、同步/嵌入本地依赖,并可选暂存额外文件 |
publish_artifact | 发布一个可发布目标 | 上传准备好的目标(或项目使用的暂存目录),附加版本、变更日志和标签 |
支持的占位符:
| 占位符 | 含义 |
|---|---|
{project_root} | 仓库根目录的绝对路径 |
{target} | 要发布的模块/技能的绝对路径 |
{artifact_dir} | 此目标的临时暂存目录的绝对路径(项目使用暂存目录时) |
{version} | 发布工作流选定的版本 |
{dry_run} | true 或 false |
{release_notes_file} | 包含发布说明/变更日志文本的 UTF-8 文件的绝对路径 |
执行规则:
- 保持技能通用:不要在此 SKILL 中硬编码注册表/包管理器/项目布局的细节。
- 如果存在
prepare_artifact,则在需要最终可发布目标状态的发布相关检查之前,对每个目标运行一次。 - 将发布说明写入临时文件,并将该文件路径传递给
publish_artifact;不要将多行变更日志文本直接嵌入 shell 命令。 - 如果没有钩子,则回退到默认的、与项目无关的发布工作流。
语言检测规则:
变更日志文件遵循 CHANGELOG_{LANG}.md 或 CHANGELOG.{lang}.md 模式,其中 {lang} / {LANG} 是语言或地区代码。
| 模式 | 示例 | 语言 |
|---|---|---|
| 无后缀 | CHANGELOG.md | en(默认) |
_{LANG}(大写) | CHANGELOG_CN.md、CHANGELOG_JP.md | 对应语言 |
.{lang}(小写) | CHANGELOG.zh.md、CHANGELOG.ja.md | 对应语言 |
.{lang-region} | CHANGELOG.zh-CN.md | 对应地区变体 |
常见语言代码:zh(中文)、ja(日语)、ko(韩语)、de(德语)、fr(法语)、es(西班牙语)。
输出示例:
Project detected:
Version file: package.json (1.2.3)
Changelogs:
- CHANGELOG.md (en)
- CHANGELOG.zh.md (zh)
- CHANGELOG.ja.md (ja)
第 2 步:分析自上一个标签以来的变更
LAST_TAG=$(git tag --sort=-v:refname | head -1)
git log ${LAST_TAG}..HEAD --oneline
git diff ${LAST_TAG}..HEAD --stat
按约定式提交类型分类:
| 类型 | 描述 |
|---|---|
| feat | 新功能 |
| fix | 错误修复 |
| docs | 文档 |
| refactor | 代码重构 |
| perf | 性能改进 |
| test | 测试变更 |
| style | 格式、样式 |
| chore | 维护(从变更日志中跳过) |
重大变更检测:
- 提交消息以
BREAKING CHANGE开头 - 提交正文/页脚包含
BREAKING CHANGE: - 移除了公共 API、重命名了导出项或更改了接口
如果检测到重大变更,向用户警告:"检测到重大变更。请考虑升级主版本(--major 标志)。"
步骤 3:确定版本号变更
规则(按优先级排序):
- 用户标志
--major/--minor/--patch→ 使用指定的版本号 - 检测到 BREAKING CHANGE → 主版本号递增(1.x.x → 2.0.0)
- 存在
feat:提交 → 次版本号递增(1.2.x → 1.3.0) - 其他情况 → 修订版本号递增(1.2.3 → 1.2.4)
显示版本变更:1.2.3 → 1.3.0
步骤 4:生成多语言变更日志
针对检测到的每个变更日志文件:
- 根据文件名后缀识别语言
- 检测第三方贡献者:
- 检查合并提交:
git log ${LAST_TAG}..HEAD --merges --pretty=format:"%H %s" - 对于每个已合并的 PR,使用
gh pr view <number> --json author --jq '.author.login'确定 PR 作者 - 使用
gh repo view --json owner --jq '.owner.login'与仓库所有者进行比较 - 如果 PR 作者 ≠ 仓库所有者 → 属于第三方贡献者
- 检查合并提交:
- 以对应语言生成内容:
- 使用目标语言的章节标题
- 使用目标语言自然地撰写变更描述(而非翻译)
- 日期格式:YYYY-MM-DD(通用格式)
- 第三方贡献:在变更日志条目后附加贡献者署名
(by @username)
- 插入文件开头(保留现有内容)
章节标题翻译(内置):
| 类型 | en | zh | ja | ko | de | fr | es |
|---|---|---|---|---|---|---|---|
| feat | 新功能 | 新功能 | 新機能 | 새로운 기능 | Funktionen | Fonctionnalités | Características |
| fix | 修复 | 修复 | 修正 | 수정 | Fehlerbehebungen | Corrections | Correcciones |
| docs | 文档 | 文档 | ドキュメント | 문서 | Dokumentation | Documentation | Documentación |
| refactor | 重构 | 重构 | リファクタリング | 리팩토링 | Refactoring | Refactorisation | Refactorización |
| perf | 性能优化 | 性能优化 | パフォーマンス | 성능 | Leistung | Performance | Rendimiento |
| breaking | 破坏性变更 | 破坏性变更 | 破壊的変更 | 주요 변경사항 | Breaking Changes | Changements majeurs | Cambios importantes |
变更日志格式:
## {VERSION} - {YYYY-MM-DD}
### Features
- Description of new feature
- Description of third-party contribution (by @username)
### Fixes
- Description of fix
### Documentation
- Description of docs changes
仅包含有变更的章节。省略空章节。
第三方署名规则:
- 仅为非仓库所有者的贡献者添加
(by @username) - 使用带
@前缀的 GitHub 用户名 - 放在变更日志条目行末尾
- 所有语言统一适用(始终使用
(by @username)格式,不翻译)
多语言示例:
英文(CHANGELOG.md):
## 1.3.0 - 2026-01-22
### Features
- Add user authentication module (by @contributor1)
- Support OAuth2 login
### Fixes
- Fix memory leak in connection pool
中文(CHANGELOG.zh.md):
## 1.3.0 - 2026-01-22
### 新功能
- 新增用户认证模块 (by @contributor1)
- 支持 OAuth2 登录
### 修复
- 修复连接池内存泄漏问题
日文(CHANGELOG.ja.md):
## 1.3.0 - 2026-01-22
### 新機能
- ユーザー認証モジュールを追加 (by @contributor1)
- OAuth2 ログインをサポート
### 修正
- コネクションプールのメモリリークを修正
步骤 5:按技能/模块对变更分组
分析自上一个标签以来的提交,并按受影响的技能/模块分组:
- 识别每个提交中变更的文件
- 按技能/模块分组:
skills/<skill-name>/*→ 归入对应技能- 根目录文件(CLAUDE.md 等)→ 归入“project”
- 单个提交涉及多个技能 → 拆分为多个组
- 针对每个组,确定需要更新的相关 README
分组示例:
baoyu-cover-image:
- feat: add new style options
- fix: handle transparent backgrounds
→ README updates: options table
baoyu-comic:
- refactor: improve panel layout algorithm
→ No README updates needed
project:
- docs: update CLAUDE.md architecture section
步骤 6:分别提交每个技能/模块
按变更顺序处理每个技能/模块组:
-
检查是否需要更新 README:
- 扫描
README*.md中对此技能/模块的提及 - 确认选项/标志的文档说明正确
- 如果语法有变化,更新用法示例
- 如果行为有变化,更新功能说明
- 扫描
-
暂存并提交:
git add skills/<skill-name>/* git add README.md README.zh.md # If updated for this skill git commit -m "<type>(<skill-name>): <meaningful description>" -
提交消息格式:
- 使用约定式提交格式:
<type>(<scope>): <description> <type>:feat、fix、refactor、docs、perf 等<scope>:技能名称或“project”<description>:清晰且有意义地描述变更
- 使用约定式提交格式:
提交示例:
git commit -m "feat(baoyu-cover-image): add watercolor and minimalist styles"
git commit -m "fix(baoyu-comic): improve panel layout for long dialogues"
git commit -m "docs(project): update architecture documentation"
常见的 README 更新需求:
| 变更类型 | 需检查的 README 章节 |
|---|---|
| 新选项/标志 | 选项表、用法示例 |
| 选项重命名 | 选项表、用法示例 |
| 新功能 | 功能说明、示例 |
| 破坏性变更 | 迁移说明、弃用警告 |
| 内部结构调整 | 架构章节(如果向用户公开) |
步骤 7:生成变更日志并更新版本
- 生成多语言变更日志(如步骤 4 所述)
- 更新版本文件:
- 读取版本文件(JSON/TOML/文本)
- 更新版本号
- 写回文件(保留格式)
- 创建发布说明文件:
- 优先使用
CHANGELOG.md中的新版本章节 - 如果不存在英文/默认变更日志,则使用第一个检测到的变更日志
- 仅提取确切的
## {VERSION} - {YYYY-MM-DD}章节,直到下一个## - 必要时同时匹配普通版本号和带标签前缀的标题,例如
1.2.3和v1.2.3 - 将重大变更放在靠前位置;必要时在其他章节之前添加简短亮点说明
- 将说明写入 UTF-8 临时文件,并在注释标签消息、GitHub Releases 和
publish_artifact中重复使用 - 在普通模式下,如果找不到说明,则停止操作,不创建空标签或 GitHub Release
- 优先使用
按文件类型划分的版本路径:
| 文件 | 路径 |
|---|---|
| package.json | $.version |
| pyproject.toml | project.version |
| Cargo.toml | package.version |
| marketplace.json | $.metadata.version |
| VERSION / version.txt | 直接内容 |
步骤 8:用户确认
创建发布提交前,询问用户并获得确认:
使用 AskUserQuestion 提出三个问题:
-
版本升级(单选):
- 显示根据步骤 3 分析得出的推荐版本
- 选项:推荐版本(附标签)、其他 semver 选项
- 示例:
1.2.3 → 1.3.0 (Recommended)、1.2.3 → 1.2.4、1.2.3 → 2.0.0
-
推送到远程(单选):
- 选项:“是,提交后推送”、“否,仅保留在本地”
-
发布 GitHub Release(单选):
- 仅在支持 GitHub Release 时提供此选项
- 如果用户也选择了推送,则默认选择“是,推送标签后发布”
- 如果用户选择将发布保留在本地,则不要创建或编辑 GitHub Release
确认前的输出示例:
Commits created:
1. feat(baoyu-cover-image): add watercolor and minimalist styles
2. fix(baoyu-comic): improve panel layout for long dialogues
3. docs(project): update architecture documentation
Changelog preview (en):
## 1.3.0 - 2026-01-22
### Features
- Add watercolor and minimalist styles to cover-image
### Fixes
- Improve panel layout for long dialogues in comic
Release notes source: CHANGELOG.md#1.3.0
Ready to create release commit, annotated tag, and GitHub Release.
步骤 9:创建发布提交和注释标签
用户确认后:
-
暂存版本和变更日志文件:
git add <version-file> git add CHANGELOG*.md -
创建发布提交:
git commit -m "chore: release v{VERSION}" -
创建注释标签:
git tag -a v{VERSION} -F <release-notes-file>如果
.releaserc.yml设置了tag.sign: true,则使用git tag -s并提供同一个说明文件。 -
在用户确认后推送(步骤 8):
git push origin main git push origin v{VERSION}
注意:不要添加 Co-Authored-By 行。这是发布提交,而不是代码贡献。
步骤 10:发布制品和 GitHub Release
项目制品发布与 GitHub Releases 是独立的输出:
-
项目制品:
- 如果存在
release.hooks.publish_artifact,则对每个已准备的目标运行一次 - 传入用于标签和 GitHub Release 的同一个
{release_notes_file} - 在 dry-run 模式下,传入
{dry_run}=true并报告将要发布的内容
- 如果存在
-
GitHub Release:
- 仅在用户确认远程发布且支持 GitHub 时运行
- 创建 Release 前,确保标签已存在于远程
- 使用提取的说明创建或更新 Release:
if gh release view v{VERSION} >/dev/null 2>&1; then gh release edit v{VERSION} --title "v{VERSION}" --notes-file <release-notes-file> else gh release create v{VERSION} --title "v{VERSION}" --notes-file <release-notes-file> --verify-tag fi - 绝不要将多行发布说明直接写入 shell 命令
发布后输出:
Release v1.3.0 created.
Commits:
1. feat(baoyu-cover-image): add watercolor and minimalist styles
2. fix(baoyu-comic): improve panel layout for long dialogues
3. docs(project): update architecture documentation
4. chore: release v1.3.0
Tag: v1.3.0
Tag type: annotated
GitHub Release: published # or "skipped/local only"
Status: Pushed to origin # or "Local only - run git push when ready"
回填现有 GitHub Releases
当用户要求回填历史版本,或传入 --backfill-releases 时,使用此模式。
- 不要升级版本、编辑变更日志或创建发布提交。
- 按版本顺序列出现有标签,并检测缺少的发布:
git tag --sort=v:refname gh release view <tag> - 对于没有 GitHub Release 的每个标签:
- 通过移除配置的标签前缀来规范化变更日志查找,例如,
v1.2.3->1.2.3 - 从
CHANGELOG.md中提取匹配的部分;如果没有,则查找第一个匹配的变更日志文件 - 如果找不到匹配的变更日志部分,则跳过发布或先询问用户
- 使用以下命令创建发布:
gh release create <tag> --title "<tag>" --notes-file <release-notes-file> --verify-tag
- 通过移除配置的标签前缀来规范化变更日志查找,例如,
- 使用
git cat-file -t <tag>检测轻量标签(commit表示轻量标签,tag表示附注标签)。 - 默认不要重写公开的轻量标签。将现有远程标签转换为附注标签需要用户明确确认,因为这会重写已发布的引用。
配置(.releaserc.yml)
项目根目录中的可选配置文件,用于覆盖默认设置:
# .releaserc.yml - Optional configuration
# Version file (auto-detected if not specified)
version:
file: package.json
path: $.version # JSONPath for JSON, dotted path for TOML
# Changelog files (auto-detected if not specified)
changelog:
files:
- path: CHANGELOG.md
lang: en
- path: CHANGELOG.zh.md
lang: zh
- path: CHANGELOG.ja.md
lang: ja
# Section mapping (conventional commit type → changelog section)
# Use null to skip a type in changelog
sections:
feat: Features
fix: Fixes
docs: Documentation
refactor: Refactor
perf: Performance
test: Tests
chore: null
# Commit message format
commit:
message: "chore: release v{version}"
# Tag format
tag:
prefix: v # Results in v1.0.0
sign: false
# Additional files to include in release commit
include:
- README.md
- package.json
试运行模式
指定 --dry-run 时:
=== DRY RUN MODE ===
Project detected:
Version file: package.json (1.2.3)
Changelogs: CHANGELOG.md (en), CHANGELOG.zh.md (zh)
Last tag: v1.2.3
Proposed version: v1.3.0
Changes grouped by skill/module:
baoyu-cover-image:
- feat: add watercolor style
- feat: add minimalist style
→ Commit: feat(baoyu-cover-image): add watercolor and minimalist styles
→ README updates: options table
baoyu-comic:
- fix: panel layout for long dialogues
→ Commit: fix(baoyu-comic): improve panel layout for long dialogues
→ No README updates
Changelog preview (en):
## 1.3.0 - 2026-01-22
### Features
- Add watercolor and minimalist styles to cover-image
### Fixes
- Improve panel layout for long dialogues in comic
Changelog preview (zh):
## 1.3.0 - 2026-01-22
### 新功能
- 为 cover-image 添加水彩和极简风格
### 修复
- 改进 comic 长对话的面板布局
Commits to create:
1. feat(baoyu-cover-image): add watercolor and minimalist styles
2. fix(baoyu-comic): improve panel layout for long dialogues
3. chore: release v1.3.0
No changes made. Run without --dry-run to execute.
使用示例
/release-skills # Auto-detect version bump
/release-skills --dry-run # Preview only
/release-skills --minor # Force minor bump
/release-skills --patch # Force patch bump
/release-skills --major # Force major bump (with confirmation)
/release-skills --backfill-releases # Create missing GitHub Releases for existing tags
适用场景
当用户提出以下请求时,触发此技能:
- “release”、“发布”、“create release”、“new version”、“新版本”
- “bump version”、“update version”、“更新版本”
- “prepare release”
- “release notes”、“GitHub Release”、“回填 Release”
- 存在未提交更改时“push to remote”
重要:如果用户在存在未提交更改时说“just push”或“直接 push”,仍需先遵循以上所有步骤。