Github 仓库自动同步/镜像到 Gitee

发布时间: 更新时间: 总字数:1006 阅读时间:3m 作者: IP上海 分享 网址

利用 Github Action,将 Github 仓库自动同步/镜像到 Gitee,支持 Github 私有仓库的同步。

介绍

build-test GoDoc Go Report Card

特点

  • 支持Github私有仓库同步到Gitee

参数

兼容 Yikun/hub-mirror-action

必要参数

  • src github/<name> name 可以是 user name 或 org name, eg: github/xiexianbin
  • src_token :smile: 扩展参数,源的 API tokens,支持 GiteeGithub
    • 若配置为 ${{ secrets.GITHUB_TOKEN }},仅支持同步公开仓库,Github Action 会中自动注入 token
    • 若需要同步私有仓库,需配置 ${{ secrets.PERSONAL_ACCESS_TOKEN }},PERSONAL_ACCESS_TOKEN 在这里创建
  • dst gitee/<name> name 可以是 user name 或 org name, eg: gitee/xiexianbin
  • dst_key 目的端和源端的 ssh private key
  • dst_token 创建仓库的API tokens,支持GiteeGithub

可选参数

  • account_type org(Organization) or user, default is user
  • src_account_type 默认为account_type,源账户类型,可以设置为org(组织)或者user(用户)。
  • dst_account_type 默认为account_type,目的账户类型,可以设置为org(组织)或者user(用户)。
  • clone_style just support ssh, and dst_key must configure both github and gitee
  • cache_path 默认为’’,将代码缓存在指定目录,用于与 actions/cache配合以加速镜像过程。
  • black_list 默认为’’,配置后,黑名单中的repos将不会被同步,如“repo1,repo2,repo3”。
  • white_list 默认为’’,配置后,仅同步白名单中的repos,如“repo1,repo2,repo3”。
  • force_update 默认为false, 配置后,启用git push -f强制同步,注意:开启后,会强制覆盖目的端仓库
  • debug 默认为false, 配置后,启用debug开关,会显示所有执行命令。
  • timeout 默认为'30m’, 用于设置每个git命令的超时时间,‘600’=>600s, ‘30m’=>30 mins, ‘1h’=>1 hours
  • mappings 源仓库映射规则,比如’A=>B, C=>CC’, A会被映射为B,C会映射为CC,映射不具有传递性。主要用于源和目的仓库名不同的镜像。
  • ssh_keyscans :smile: 扩展参数,默认为 github.com,gitee.com

如何使用

  • Github Action

Sample Use

      - name: git mirror
        uses: x-actions/git-mirrors@main
        with:
          src: github/${{ matrix.github }}
          src_token: ${{ secrets.GITHUB_TOKEN | secrets.PERSONAL_ACCESS_TOKEN }}
          dst: gitee/${{ matrix.gitee }}
          dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}
          dst_token: ${{ secrets.GITEE_TOKEN }}
          account_type: user
          cache_path: "/github/workspace/git-mirrors-cache"
          black_list: "openbilibili,test1"
          clone_style: ssh

all Params

      - name: git mirror
        uses: x-actions/git-mirrors@main
        with:
          src: github/${{ matrix.github }}
          src_token: ${{ secrets.GITHUB_TOKEN }}
          dst: gitee/${{ matrix.gitee }}
          dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}
          dst_token: ${{ secrets.GITEE_TOKEN }}
          account_type: user
          # src_account_type: org
          # dst_account_type: org
          cache_path: "/github/workspace/git-mirrors-cache"
          black_list: "openbilibili,test1"
          white_list: "w1,w2"
          clone_style: ssh
          force_update: false
          debug: true
          timeout: 30m
          mappings: "A=>B, C=>CC"
  • command line
# download
curl -Lfs -o git-mirrors https://github.com/x-actions/git-mirrors/releases/latest/download/git-mirrors-{linux|darwin|windows}
chmod +x git-mirrors

# help
./git-mirrors -h

# demo
git-mirrors \
  --src "github/estack" \
  --src-token "${GITHUB_TOKEN}" \
  --dst "gitee/e-stack" \
  --dst-key "" \
  --dst-token "${GITEE_TOKEN}" \
  --account-type "user" \
  --clone-style "ssh" \
  --cache-path "./temp/" \
  --black-list "" \
  --white-list "" \
  --force-update=true \
  --debug=true \
  --timeout "10m"

FaQ

  • ssh key err
clone git@github.com:xx/xx.git err: unknown error: ERROR: You're using an RSA key with SHA-1, which is no longer allowed. Please use a newer client or a different key type.

regenerate ssh key:

$ ssh-keygen -t ed25519 -C "your_email@example.com"

# or
$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

more info go to https://github.blog/2021-09-01-improving-git-protocol-security-github/

Ref

  • 采用兼容 Yikun/hub-mirror-action 的配置参数,因此不可避免的参考其实现,在此表示感谢。
Home Archives Categories Tags Statistics
本文总阅读量 次 本站总访问量 次 本站总访客数