Release Assistant | 發布助手
Guide the release process following Semantic Versioning and changelog best practices.
引導遵循語義化版本和變更日誌最佳實踐的發布流程。
Subcommands | 子命令
| Subcommand | Mode | Description | 說明 |
|---|---|---|---|
start |
All | Start a release branch/process | 開始發布流程 |
finish |
CI/CD | Finalize release (tag, merge) | 完成發布(標籤、合併) |
promote |
Manual/Hybrid | Promote RC to Stable | RC → Stable 晉升 |
deploy |
Manual/Hybrid | Record deployment to environment | 記錄部署紀錄 |
manifest |
Manual/Hybrid | Generate build-manifest.json | 產生打包資訊清單 |
verify |
Manual/Hybrid | Verify manifest consistency | 驗證清單一致性 |
changelog |
All | Generate or update CHANGELOG.md | 產生或更新變更日誌 |
check |
All | Run pre-release verification | 執行發布前檢查 |
Release Modes | 發布模式
Configure via uds init or uds config --type release_mode:
| Mode | Description | 說明 |
|---|---|---|
ci-cd |
Automatic publishing via CI/CD pipeline (default) | CI/CD 自動發布(預設) |
manual |
Manual packaging + RC workflow | 手動打包 + RC 工作流程 |
hybrid |
CI builds artifact + manual deployment | CI 建置 + 手動部署 |
Version Types | 版本類型
| Type | Pattern | npm Tag | 用途 |
|---|---|---|---|
| Stable | X.Y.Z |
@latest |
Production release |
| Beta | X.Y.Z-beta.N |
@beta |
Public testing |
| Alpha | X.Y.Z-alpha.N |
@alpha |
Internal testing |
| RC | X.Y.Z-rc.N |
@rc |
Release candidate |
Workflow | 工作流程
- Determine version - Decide version type based on changes (MAJOR/MINOR/PATCH)
- Triage open issues/PRs -
gh pr list+gh issue list; classify each bring-in vs defer (XSPEC-265) / 掃描 issue/PR、每項二分(帶上 vs backlog) - Update version files - Update package.json and related version references
- Update CHANGELOG - Move [Unreleased] entries to new version section
- Run pre-release checks - Verify tests, lint, standards compliance, and issue/PR triage gate
- Create git tag - Tag with
vX.Y.Zformat - Commit and push - Commit version bump and push tags
Pre-release Issue/PR Triage Gate | 發版前 issue/PR triage 閘門 (XSPEC-265)
Before bumping, scan open issues/PRs and make a conscious decision per item — do not rely on memory:
| Class | Action |
|---|---|
| Bring-in | patch dependabot PR / release-blocking bug / fix relevant to this version's theme → merge before bump |
| Defer | major PR, audit/enhancement issue, needs separate evaluation → record in signoff "deferred" + release-notes Known Issues |
- Confirm
cross-project/sub-project-triage.mdsnapshot is recent (≤7 days); refresh if stale. - Record the result in the release sign-off (Tier-1):
Pre-release issue/PR triage | PASS | N PRs / M issues: X merged / Y deferred. - Do not require emptying the backlog — only that every item has a conscious decision + a record. 不要求清空 backlog,只要求每項有意識決策 + 留紀錄。
Version Increment Rules | 版本遞增規則
| Change Type | Increment | Example |
|---|---|---|
| Breaking changes | MAJOR | 1.9.5 → 2.0.0 |
| New features (backward-compatible) | MINOR | 2.3.5 → 2.4.0 |
| Bug fixes (backward-compatible) | PATCH | 3.1.2 → 3.1.3 |
Usage | 使用方式
CI/CD Mode (default)
/release start 1.2.0- Start release process for v1.2.0/release changelog 1.2.0- Update CHANGELOG for v1.2.0/release finish 1.2.0- Finalize and tag v1.2.0/release check- Run pre-release verification
Manual Mode (RC workflow)
/release start 1.2.0-rc.1- Create RC versionuds release manifest- Generate build-manifest.jsonuds release deploy staging- Record staging deploymentuds release deploy staging --result passed- Record test result/release promote 1.2.0- Promote RC to stableuds release deploy production- Record production deploymentuds release verify- Verify manifest consistency
Next Steps Guidance | 下一步引導
After /release completes, the AI assistant should suggest:
發布流程完成。建議下一步 / Release process complete. Suggested next steps:
- 驗證 npm 發布狀態
npm view <pkg> dist-tags⭐ Recommended / 推薦 — Verify npm publication status- 建立 GitHub Release 並撰寫發布說明 — Create GitHub Release with notes
- 通知利害關係人新版本已發布 — Notify stakeholders of new release
Reference | 參考
- Changelog Format Guide — Read it when writing or reviewing a changelog entry.
- Release Workflow Guide — Read it when actually cutting a release, step by step.
- Semantic Versioning Guide — Read it when deciding whether a change is major, minor or patch.
- Detailed guide: guide.md
- Core standard: versioning.md
AI Agent Behavior | AI 代理行為
完整的 AI 行為定義請參閱對應的命令文件:
/releaseFor complete AI agent behavior definition, see the corresponding command file:
/release