SuperAPI AI 工具集

cross-repo-change

编程与开发

查看项目

更新于 10-29 14:22

技能介绍

用途

跨仓库变更用于规划和执行横跨多个代码仓库的变更。其核心规则是:从第一次部署到最后一个部署之间的每一刻,每个仓库的每个已部署版本都必须能与其他仓库的已部署版本正常工作。实现方式是给变更排序,而不是依赖“同时部署”(实际很少发生)。

主要能力

  • 依据影响分析报告获取各仓库的消费方列表。
  • 读取仓库地图中的 Connections 表,了解仓库之间的通信方式(HTTP、共享数据库、队列、webhook、共享包)。
  • 了解每个仓库的部署方式与耗时,尤其关注移动应用这类旧版本长期存留的慢速场景。
  • 针对多种变更类型给出排序策略:
    • 提供方/消费方变更(如后端 API 被 Web 应用使用):提供方先扩展(新增字段/端点/行为,不删除旧内容),更新契约测试后部署;消费方逐个切换到新形态并部署;最后由提供方移除旧形态(移动端需等旧版本低于支持阈值)后部署。
    • 消费方需要新能力且无删除:提供方先、消费方后,两步完成。
    • 共享数据库(其他服务读取你的表):把列当作 API 字段处理,先新增,让读取方切换,再删除;不得重命名或删除读取方仍在使用的列。
    • 队列/webhook 载荷:消费方必须先能同时接受新旧载荷,生产方再发送新载荷,因此消费方先行。
    • 共享 Python 包:发布新版本,在各仓库分别升级版本;同一版本中不得破坏旧版本的 API。
    • 无法安全排序(确实需要同时变更)时:在消费方使用功能开关,先以关闭状态部署全部内容,再打开开关。

使用方式

  1. 准备输入:影响分析报告(若不存在则先运行)、仓库地图的连接信息、各仓库部署方式与耗时。
  2. 对变更排序,参照上述场景选择默认顺序或特殊顺序。
  3. 编写计划,放在 epic 或第一个 PR 中,并从每个 PR 链接过去。计划表字段包括:序号、仓库、PR、变更内容、部署前置条件、是否可安全回滚。示例条目如:后端 PR #412 在 /api/invoices 中新增 state 字段并保留 status;web-app PR #88 读取 state,需 #412 已在生产生效;reporting PR #31 读取 state 列;后端 PR #420 移除 status,需 #88 与 #31 已在生产生效,可回滚(重新加回字段)。表中还需列出契约测试路径(如 backend/tests/contracts/test_invoice_contract.py)和功能开关情况(示例为 none)。
  4. 逐个仓库执行:跨仓库共享工单键作为分支名(如 ABC-123-invoice-state)便于查找;每个 PR 描述链接计划并注明“depends on: # 已部署到 环境”;合并某一步前,确认其“Deploy after”条件在目标环境中确实满足,而不仅仅是已合并;为后续步骤(尤其是契约移除步骤)创建 Jira 工单以免遗忘。

规则

  • 不得合并只有依赖另一个仓库未合并 PR 已部署才能工作的 PR。
  • 不得在添加替代物的同一发布中移除消费方正在使用的内容。
  • 如果计划超过约 4 步,应检查变更是否可以拆得更小。

适用场景

适用于涉及后端 API 与前端应用、共享数据库、消息队列、webhook 以及共享 Python 包等多仓库协同的变更规划与执行。

限制

资料未说明该技能的安装命令、平台支持范围、收费方式及具体效果指标;示例中的仓库名、PR 编号、字段名和工单键仅作演示,实际使用需替换为真实信息。