Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.29 KB

RELEASING.md

File metadata and controls

34 lines (25 loc) · 1.29 KB

SDK 发布流程

SDK 采用 SemVer + tag 驱动发布。首个版本为 1.0.0。

步骤

  1. 更新 go/controlplatform/version.go 中的 Version(例如 "1.0.0")。

  2. 更新 go/CHANGELOG.md,记录新增、变更、修复与发布说明。

  3. 更新 go/README.md / go/README_EN.md 中的版本号与示例。

  4. 提交到 main 并推送。

  5. 打 tag 并推送(Go module 位于 go/ 子目录,tag 需带 go/ 前缀):

    git tag go/v1.0.0
    git push origin go/v1.0.0
  6. .github/workflows/publish.yml 自动执行:

    • 校验 go build ./...、go vet ./...、go test ./...;
    • 将 SDKHash 注入当前 commit SHA,并按 tag 同步 Version;
    • 触发 pkg.go.dev 重新索引(go list -m);
    • 创建 GitHub Release(CHANGELOG.md 作为 notes);
    • 通知控制中台 webhook(可选,未配置时跳过且不阻断)。

版本规则

  • 破坏性 API 变更 → 升级 MAJOR。
  • 新增向后兼容能力 → 升级 MINOR。
  • 修复/文档 → 升级 PATCH。
  • 禁止改写已发布的 tag。

待补服务端能力

控制中台接收 SDK 发布通知的 POST /api/v1/sdk/webhook 端点尚未实现时,可将 GitHub secret CP_SDK_WEBHOOK_URL/CP_SDK_WEBHOOK_SECRET 留空,CI 会跳过通知步骤。