| name | release |
| description | 用于发布 arthas-for-vscode 扩展的新版本。包含更新版本号、更新 CHANGELOG.md 以及推送 git tag 触发自动发布流程。 |
发布新版本 (Release)
本 Skill 用于指导完成 arthas-for-vscode 插件的版本迭代与发布流程。
准备工作
在开始发布前,请确保:
- 当前分支代码已通过测试。
- 已安装必要的依赖(
npm install)。
执行步骤
1. 确定新版本号
根据当前版本(查看 package.json 中的 version),按照 语义化版本 (SemVer) 规范确定新版本号。
- Patch: 修补错误(如 1.2.0 -> 1.2.1)
- Minor: 新增功能但向下兼容(如 1.2.0 -> 1.3.0)
- Major: 突破性的 API 变更(如 1.2.0 -> 2.0.0)
2. 生成变更日志 (Changelog)
从上一个发布版本以来提取变更。运行以下命令获取自上个 tag 以来的 commit 记录:
git log $(git describe --tags --abbrev=0)..HEAD --oneline
分析这些 commit 记录,并按照 CHANGELOG.md 的格式进行归类:
Added: 新增功能
Changed: 功能变更
Fixed: 修复 Bug
Improved: 性能优化或代码改进
3. 更新项目文件
必须同步更新以下两个文件:
更新 package.json
将 "version": "x.y.z" 字段更新为确定的新版本号。
更新 CHANGELOG.md
在 ## [Unreleased] 下方或文件顶部(紧随标题之后)插入新版本的记录。格式如下:
## [x.y.z] - YYYY-MM-DD
### Added
- 描述新增的内容...
### Fixed
- 描述修复的内容...
重要提示:确保格式与现有文件一致,特别是 ## [x.y.z] 部分,因为 GitHub Actions 将通过此正则匹配来提取发布日志。
4. 提交更改并推送 Tag
完成文件更新后,执行以下步骤提交代码并打标签:
-
提交代码:
git add package.json CHANGELOG.md
git commit -m "chore: release vX.Y.Z"
-
创建 Tag:
git tag vX.Y.Z
-
推送代码与 Tag:
git push origin main
git push origin vX.Y.Z
5. 监控发布状态
一旦推送了以 v 开头的 Tag,GitHub Actions 的 发布扩展 (release.yml) 将被触发。
请前往 Settings > Actions 监控工作流。完成后,它将自动:
- 在 GitHub 创建一个新的 Release。
- 发布到 VS Code Marketplace。
- 发布到 Open VSX。
常见问题
- Tag 推送错误: 若 tag 推送早于文件更新,GA 提取的 changelog 可能是旧的。请撤回 tag 并重新更新后推送。
- 发布失败: 检查
VSCODE_PAT 或 OPEN_VSX_TOKEN 密钥是否过期。