jderusse/gitsplit

jderusse/gitsplit镜像说明

镜像概述

该Docker镜像集成了git工具与splitsh-lite轻量级仓库拆分工具，旨在帮助用户将大型Git仓库按目录前缀拆分为多个模块化子仓库，支持缓存优化和多种认证方式，可无缝对接主流CI/CD平台。

核心功能

• 按目录前缀拆分仓库至多个目标仓库
• 缓存机制加速重复拆分过程
• 支持GitHub Token、SSH密钥等认证方式
• 兼容Drone、Travis CI、GitLab CI/CD、GitHub Actions等环境

使用场景

• 大型单体仓库拆分为模块化子仓库
• 多团队协作时拆分不同模块至独立仓库
• CI/CD流程中自动完成仓库拆分与推送

配置说明

需在仓库根目录创建.gitsplit.yml配置文件，示例如下：

yaml
# 缓存目录路径（加速拆分）
cache_url: "/cache/gitsplit"
# 待拆分项目路径（可选，默认当前路径）
# project_url: "https://${GH_TOKEN}@github.com/your-org/your-project.git"
# 拆分规则列表
splits:
  - prefix: "src/moduleA"
    target: "https://${GH_TOKEN}@github.com/your-org/moduleA.git"
  - prefix: ["src/moduleB:", "src/common/utils:lib/utils"]
    target: ["https://${GH_TOKEN}@github.com/your-org/moduleB.git"]
# 需要拆分的分支/标签（正则表达式）
origins:
  - ^main$
  - ^develop$
  - ^feature/
  - ^v\d+\.\d+\.\d+$

部署示例

手动拆分（GitHub Token）

bash
docker run --rm -ti -e GH_TOKEN -v /local/cache:/cache/gitsplit -v $PWD:/srv jderusse/gitsplit

手动拆分（SSH代理）

bash
docker run --rm -ti -e SSH_AUTH_SOCK=/ssh-agent -v $SSH_AUTH_SOCK:/ssh-agent -v /local/cache:/cache/gitsplit -v $PWD:/srv jderusse/gitsplit

Drone.io集成

yaml
# .drone.yml
pipeline:
  split:
    image: jderusse/gitsplit
    pull: true
    volumes:
      - /drone/cache/gitsplit:/cache/gitsplit
      - /drone/env/ssh:/root/.ssh/
    commands:
      - git fetch --prune --unshallow || git fetch --prune
      - gitsplit

Travis CI集成

yaml
# .travis.yml
sudo: required
services: [docker]
cache: {directories: [/cache/gitsplit]}
install:
  - docker pull jderusse/gitsplit
  - git config remote.origin.fetch "+refs/*:refs/*" && git fetch --prune --unshallow || git fetch --prune
script:
  - docker run --rm -t -e GH_TOKEN -v /cache/gitsplit:/cache/gitsplit -v $PWD:/srv jderusse/gitsplit gitsplit --ref "${TRAVIS_BRANCH}"

GitLab CI/CD集成

yaml
# .gitlab-ci.yml
stages: [split]
split:
  image: jderusse/gitsplit
  stage: split
  cache: {key: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME", paths: [cache/gitsplit]}
  variables: {GIT_STRATEGY: clone}
  before_script:
    - eval $(ssh-agent -s)
    - mkdir -p ~/.ssh && chmod 700 ~/.ssh
    - echo -e "Host *\n\tStrictHostKeyChecking no\n" > ~/.ssh/config
    - echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add - > /dev/null
  script:
    - git config remote.origin.fetch "+refs/*:refs/*" && git fetch --prune --unshallow || git fetch --prune
    - gitsplit --ref "${CI_COMMIT_REF_NAME}"

GitHub Actions集成

yaml
# .github/workflows/gitsplit.yml
name: gitsplit
on: {push: {branches: [main]}, release: {types: [published]}}
jobs:
  gitsplit:
    runs-on: ubuntu-latest
    steps:
      - name: 克隆仓库
        run: git clone https://github.com/your-org/your-project /home/runner/work/your-project
      - name: 拆分仓库
        uses: docker://jderusse/gitsplit:latest
        with: {args: gitsplit}
        env: {GH_TOKEN: ${{ secrets.PRIVATE_TOKEN }}}