droboticflow/docs/release-checklist.zh-CN.md

3.6 KiB
Raw Permalink Blame History

发布清单与回滚指引(公司集群 droboticflow-fanyu)

权威入口声明:Fanyu(droboticflow-fanyu)镜像发布、预检、部署、业务验收与回退已全面切换至 docs/release/README.md 与 python3 scripts/release.py。 scripts/deploy-k8s.sh 已硬编码拦截 DEPLOY_ENV=fanyu 与 K8S_NAMESPACE=droboticflow-fanyu(直接退出 2);本文档已移除旧版直接调用 deploy-k8s.sh 或 build-and-push-images.sh 投产 Fanyu 的可执行命令,防止误触发全量 apply。

1. Fanyu 标准发布五步(唯一可执行路径)

完整参数、策略约束(docs/release/fanyu-policy.json)及证据要求见 docs/release/README.md:

  1. 查看当前发布状态与历史记录:
    python3 scripts/release.py status
    python3 scripts/release.py status <release-id>
    
  2. 构建带源码戳的不可变镜像并 Prepare(离线):
    • 使用干净工作树,通过 scripts/release-build-api-image.sh 构建并推送带 DROBOTICFLOW_BUILD_COMMIT / DROBOTICFLOW_BUILD_TIME 的 digest 镜像(repository@sha256:...)。
    • 执行 python3 scripts/release.py prepare --id <release-id> ... 绑定候选版本与目标集群身份。
    • 发布前运行 python3 scripts/release_source_audit.py 核对候选代码是否包含线上 API、切片处理器与 Worker 的全部已部署修复。
  3. 运行本地门禁与集群只读预检(Check):
    python3 scripts/release.py check <release-id> --local
    python3 scripts/release.py check <release-id> --cluster
    
    • 包含 build:web + test:production:boot 生产前端产物启动门禁、审核权限门禁(test:browser:review-permissions)及看板稳定性门禁(scripts/test_dashboard_stability.py)。
  4. 生成计划并录入人工审查证据(Plan & Evidence):
    python3 scripts/release.py plan <release-id>
    python3 scripts/release.py evidence <release-id> --check image-provenance --result passed --file <evidence-file> --note '...'
    python3 scripts/release.py evidence <release-id> --check change-safety --result passed --file <evidence-file> --note '...'
    
  5. 经用户明确授权后部署与验收(Deploy & Verify):
    • 展示 plan 输出并取得用户对本次部署的明确授权后,传入真实消息引用执行 python3 scripts/release.py deploy <release-id> --confirm-plan <plan-hash> --approval-ref <ref>。
    • 部署遵循先切片处理器、完整 rollout 后再更新 API 的固定顺序。
    • 部署后运行 python3 scripts/release.py verify <release-id>,并按 requiredEvidence 补齐只读/隔离业务验收证据,直至状态进入 accepted_with_evidence。

2. 范围外变更与回退原则

  • 配置、Worker/Coordinator 或算子镜像变更:不在 release.py 首版自动补丁范围内;需单独制定审查计划并取得用户明确授权。内置算子清单与 digest 校验仍使用 npm run operators:images:check。
  • 故障与回退:
    • 遇到 outcome_unknown 或部分更新时,先运行 python3 scripts/release.py verify <release-id> 核实集群状态,严禁重跑旧版全量 kubectl apply 或 deploy-k8s.sh。
    • 回退必须取得用户新的明确授权,核对当前版本与数据兼容性后按条件式变更执行(详见 docs/release/README.md「故障、回退和紧急修复」节)。
  • 非 Fanyu 环境(如 POC):仍按 AGENTS.md 的 Deployment Environment 路由规则与 README.md 中的 POC 验收脚本执行。