SuperAPI AI 工具集

github-sync

部署与运维

查看项目

更新于 10-16 05:10

技能介绍

用途

GitHub Sync 是一个多仓库同步协调技能,用于跨多个仓库进行包同步和版本对齐,并通过智能集群协调实现无缝的多仓库工作流。它主要解决多包仓库(monorepo 或多仓库)中依赖版本不一致、文档不同步、跨包功能集成困难等问题。

主要能力

  • 包依赖同步与冲突解决
  • 跨多个仓库的版本对齐
  • 带自动化测试的跨包集成
  • 文档同步以保持一致性
  • 与部署流水线配合的发布协调

使用方式

该技能通过 gh CLI 和 GitHub API 执行操作,典型流程包括:

  1. 读取各仓库的 package.json 等文件状态,比较并识别版本差异。
  2. 创建同步分支(如 sync/package-alignment)。
  3. 更新文件以对齐版本,提交到同步分支。
  4. 创建 PR 供审查。

文档同步示例:从主仓库获取 CLAUDE.md 内容,在目标仓库创建同步分支,更新目标文档并提交。

跨包功能集成示例:向功能分支推送多个文件,创建协调 PR,并在 PR 描述中列出变更和测试项。

该技能还提供 MCP 工具集成,包括集群协调同步(初始化同步协调集群、在内存中存储同步状态、编排验证、负载均衡同步任务)和冲突解决(初始化冲突解决集群、存储冲突上下文、协调解决)。

同步策略

  • 版本对齐策略:将 Node 版本对齐到最高要求(如 >=20.0.0),依赖使用最新稳定版,engines 采用 highest_common 策略。
  • 文档同步模式:指定单一事实来源(如 primary-repo/CLAUDE.md),目标仓库列表,以及各仓库的自定义部分。

最佳实践

  1. 原子同步:对相关变更使用批量操作,保持所有同步操作的一致性,为失败的同步实现回滚机制。
  2. 版本管理:语义化版本对齐,依赖兼容性验证,自动化版本号提升协调。
  3. 文档一致性:共享概念使用单一事实来源,包特定自定义放在单独部分,自动化文档验证。
  4. 测试集成:合并前进行跨包测试验证,集成测试自动化,性能回归检测。

错误处理

提供恢复流程,包括检查同步状态、回滚失败的同步(删除同步分支)、使用新分支重试。常见问题及解决方案:版本冲突使用 highest_common 策略;合并冲突需手动解决;测试失败需在合并前运行集成测试。

监控与指标

同步质量指标包括包版本对齐百分比、文档一致性得分、集成测试成功率、同步完成时间。自动化报告可通过 gh api 生成同步状态报告,检查同步 PR 的 CI 状态。

适用场景

  • 包同步:在 monorepo 包之间对齐版本
  • 依赖更新:协调主要依赖升级
  • 文档同步:保持 README/CLAUDE.md 文件一致
  • 发布协调:管理同步发布
  • 跨仓库功能:实现跨多个包的功能

限制

该技能依赖 gh CLI 和 GitHub API,需要相应的访问权限。资料中未提供关于收费、价格、平台支持范围等具体信息。版本历史显示 1.0.0(2026-01-02)为初始技能转换版本。相关技能包括 github-workflow、github-swarm-pr、github-swarm-issue。