botsudo/action-fork-sync

同步Fork仓库的GitHub Action

镜像概述和主要用途

该GitHub Action用于自动同步fork仓库与上游源仓库的指定分支，确保fork仓库的代码与源仓库保持一致。通过配置分支列表、认证信息和同步策略，可实现自动化的fork仓库维护，简化开发者同步上游代码的流程。

核心功能和特性

• 多分支同步：支持同时指定多个分支进行同步（如master、STABLE、next等）
• 灵活同步方法：提供三种同步策略，包括快速前进（fast-forward）、变基（rebase）和合并（merge）
• 干运行模式：支持配置dry-run参数，验证同步配置而不实际执行同步操作
• 可配置克隆深度：允许设置克隆仓库的深度，优化同步性能（默认100）
• 安全认证：通过令牌（token）认证访问私有仓库，确保同步过程的安全性

使用场景和适用范围

适用于需要长期维护fork仓库的开发者或团队，特别是在以下场景：

• 需要定期同步上游源仓库更新的fork项目
• 维护多个分支的fork仓库，需确保各分支与上游同步
• 自动化CI/CD流程中需依赖最新上游代码的场景
• 团队协作中需要统一fork仓库代码版本的场景

使用方法和配置说明

基本用法

在GitHub Actions工作流文件中添加如下步骤，配置同步参数即可实现fork仓库同步。

参数说明

示例配置

yml
- name: 同步我的fork仓库
  uses: sudo-bot/action-fork-sync@v1.0.1
  with:
      branches: master, STABLE, next
      source-url: "https://${{ secrets.BOT_TOKEN }}:x-oauth-basic@github.com/orgname/officialproject.git"
      # 为令牌授予repo作用域，并确保令牌用户（如机器人）有权访问myname/officialproject-fork
      fork-url: "https://${{ secrets.BOT_TOKEN }}:x-oauth-basic@github.com/myname/officialproject-fork.git"
      dry-run: "true" # 移除此行以实际执行同步
      clone-depth: "100" # 可选，默认为100
      sync-method: "fast-forward" # 可选，默认为"fast-forward"，可设为"rebase"、"merge"或"fast-forward"

注意事项

• 确保用于认证的令牌（如BOT_TOKEN）具有源仓库和fork仓库的访问权限，且已授予repo作用域
• 干运行模式（dry-run: "true"）仅用于验证配置，实际同步需移除该参数或设为"false"
• 选择合适的同步方法：快速前进（fast-forward）适用于无冲突的线性历史，变基（rebase）可保持历史整洁，合并（merge）会创建合并提交