traefik/gallienii

Myrmica Gallienii - 保持 Fork 仓库同步

https://github.com/traefik/gallienii/workflows/Main/badge.svg?branch=master](https://github.com/traefik/gallienii/actions)

通过创建 Pull Request（PR）保持 GitHub Fork 仓库与源仓库同步的工具。

镜像概述与主要用途

Myrmica Gallienii 是一款专注于 GitHub Fork 仓库同步的工具，旨在自动化 Fork 仓库与源仓库（父仓库）的同步过程。它通过读取预定义的配置文件，检测 Fork 仓库与源仓库的差异，并自动创建 PR 以合并更新，减少手动同步的繁琐操作。支持多仓库配置、冲突检测与标签标记，适用于需要维护多个 Fork 仓库的开发者或团队。

核心功能与特性

• 多仓库同步：通过 TOML 配置文件定义多个仓库的同步规则
• 灵活的 Fork 验证：可选择是否跳过 Fork 仓库的有效性验证
• 冲突处理：自动检测同步冲突并为 PR 添加冲突标签
• PR 标签管理：支持为自动创建的 PR 添加自定义标签（如同步标识、冲突标识）
• 配置文件生成：支持通过命令快速生成示例配置或基于 GitHub 组织/用户生成配置
• 干运行模式：支持在不实际创建 PR 的情况下测试同步流程

使用场景与适用范围

• 维护多个 GitHub Fork 仓库，需要定期同步源仓库更新的开发者
• 团队或组织管理多个 Fork 项目，希望减少手动同步工作量
• 需要自动化处理 Fork 与源仓库冲突检测及标记的场景

详细配置与使用方法

配置文件说明

需通过 TOML 配置文件定义待同步的仓库规则，默认使用 ./gallienii.toml，可通过 --config-path 参数指定自定义路径。

配置文件示例（TOML）

toml
[[repository]]
  # 若设为 true，跳过 GitHub 上的 Fork 有效性验证
  NoCheckFork = true
  # 若设为 true，忽略当前仓库配置
  Disable = false
  # 源仓库（父仓库）信息
  [repository.Base]
    Owner = "moby"  # 源仓库所有者
    Name = "moby"   # 源仓库名称
    Branch = "master"  # 源仓库分支
  # Fork 仓库信息
  [repository.Fork]
    Owner = "login"  # Fork 仓库所有者（登录名）
    Name = "moby"    # Fork 仓库名称
    Branch = "master"  # Fork 仓库分支
  # 自动创建的 PR 标签配置
  [repository.Marker]
    # 仅当 PR 存在冲突时添加此标签，留空则禁用
    NeedResolveConflicts = "human/need-resolve-conflicts"
    # 所有自动创建的 PR 均添加此标签
    ByBot = "bot/upstream-sync"

配置字段说明

命令使用说明

同步 Fork 仓库

基本命令：

bash
gallienii sync -t <GitHub令牌>

参数说明：

示例：

• 使用默认配置文件同步，启用详细日志：

  bash
  gallienii sync -t my_github_token --verbose true
  

• 指定配置文件路径并禁用干运行（实际创建 PR）：

  bash
  gallienii sync -t my_github_token --config-path /path/to/config.toml --dry-run false
  

生成配置文件

通过 gen 命令生成配置文件，支持生成示例配置或基于 GitHub 组织/用户生成。

命令参数：

示例：

• 生成示例配置文件：

  bash
  gallienii gen --sample
  

• 基于 GitHub 组织生成配置：

  bash
  gallienii gen --org "我的组织名" -t my_github_token
  

• 基于 GitHub 用户生成配置：

  bash
  gallienii gen --user "我的用户名" -t my_github_token
  

查看帮助信息

查看主命令帮助：

bash
gallienii -h

查看同步命令帮助：

bash
gallienii sync -h

查看生成配置命令帮助：

bash
gallienii gen -h

Docker 部署示例

基本运行（同步一次）

bash
docker run --rm -v $(pwd)/gallienii.toml:/app/gallienii.toml traefik/gallienii sync -t your_github_token --dry-run false

挂载自定义配置文件路径

bash
docker run --rm -v /path/to/your/config.toml:/custom/config.toml traefik/gallienii sync -t your_github_token --config-path /custom/config.toml

生成示例配置文件到本地

bash
docker run --rm -v $(pwd):/app traefik/gallienii gen --sample

名称含义

Myrmica gallienii 是一种蚂蚁的学名，象征工具如蚂蚁般高效、自动化地完成仓库同步工作。