跳到主要内容

发布流程

本文说明文档站与运行时组件发布时需要同步维护的内容。

发布对象

一次正式发布至少需要确认:

  • testudo-chart Helm Chart 版本。
  • testudo-operator 镜像 tag。
  • testudo-server 镜像 tag。
  • testudo-web 镜像 tag。
  • CRD schema 变化。
  • OpenAPI spec 变化。
  • 文档站版本和发布说明。

发布前检查

pnpm build

运行时仓库还应执行各自的测试和 lint,具体以仓库 Makefile 和 CI 为准。

文档检查:

  • README 第一屏入口正确。
  • 安装、升级、回滚、卸载路径正确。
  • testudo-charthelm-repo release 中已包含最新 index.yamltestudo-chart-<version>.tgzvalues*.yaml
  • 兼容性矩阵版本已更新。
  • API 文档和 OpenAPI spec 已同步。
  • 中英文页面都存在。
  • 关键截图仍然匹配当前控制台。

发布说明

Release notes 应至少包含:

  • 新增能力。
  • 修复问题。
  • 兼容性变化。
  • 破坏性变更。
  • 升级步骤。
  • 回滚说明。
  • 已知问题。

文档版本

稳定版本发布后,应使用 Docusaurus versioning 冻结当时的文档。current 保持为下一版本开发文档。

GitHub 与 Gitee

GitHub 是事实源。Release、Issue、Pull Request、安全报告和治理流程都应在 GitHub 处理。Gitee 如提供,应作为同步镜像。