Actions 样例

定时同步 GitHub 的代码仓库到 Gitee

该功能已经有很多实现了，这篇文章以 https://github.com/Yikun/hub-mirror-action 项目为例。这个项目的基本逻辑是这样的：

通过 GitHub Actions 构建一个 Docker 容器，在 Docker 容器中，引入 Gitee 的私钥，这样可以在容器中使用 git 命令向 Gitee push 代码而不用输入密码了
容器启动后，在容器内 pull github 上的代码，并 push 到 gitee 上。

首先先来一个最基本的 Action 的 workflow 文件示例

name: Gitee repos mirror periodic job
on:
  # 取消 push 的注释后，向本仓库推送代码即可开始 Gitee 同步
  # push:
  schedule:
    # 每天北京时间9点跑
    - cron: "0 1 * * *"
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Cache phpdragon src repos
        # 使用 github 官方提供的 action 来引用发行版的主要版本
        uses: actions/cache@v1
        with:
          path: /home/runner/work/phpdragon/phpdragon-cache
          key: ${{ runner.os }}-phpdragon-repos-cache
      - name: Mirror the Github organization repos to Gitee.
        # 这里我将对方项目原封不动 copy 到自己的 github 上了，所以这个步骤就直接使用自己的 action
        uses: DesistDaydream/hub-mirror-action@main
        with:
          # 必选，需要同步的Github用户（源）
          src: github/DesistDaydream
          # 必选，需要同步到的Gitee的用户（目的）
          dst: gitee/DesistDaydream
          # 必选，Gitee公钥对应的私钥
          dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}
          # 必选，Gitee对应的用于创建仓库的token
          dst_token: ${{ secrets.GITEE_TOKEN }}
          # 黑、白名单，静态名单机制，可以用于更新某些指定库
          # static_list: repo_name
          black_list: "eHualu,kubernetesAPI,v2ray"
          # white_list: 'repo_name,repo_name2'
          # force_update: true

必选参数

src 需要被同步的源端账户名，如 github/DesistDaydream，表示 Github 的 DesistDaydream 账户。
dst 需要同步到的目的端账户名，如 gitee/DesistDaydream，表示 Gitee 的 DesistDaydream 账户。
dst_key 与 Gitee 公钥对应的私钥，给 GitHub Actions 激活后创建的容器中 git 命令认证所用。
dst_token 用于自动创建不存在的仓库。
注意： dst_key 与 dst_token 的值是通过 GitHub 的 Secrets 功能引用的，类似于 k8s 的 secret 功能。

可选参数

account_type 默认为 user，源和目的的账户类型，可以设置为 org（组织）或者 user（用户），目前仅支持同类型账户（即组织到组织，或用户到用户）的同步。
clone_style 默认为 https，可以设置为 ssh 或者 https。
cache_path 默认为’’, 将代码缓存在指定目录，用于与 actions/cache 配合以加速镜像过程。
black_list 默认为’’, 配置后，黑名单中的 repos 将不会被同步，如“repo1,repo2,repo3”。
white_list 默认为’’, 配置后，仅同步白名单中的 repos，如“repo1,repo2,repo3”。
static_list 默认为’’, 配置后，仅同步静态列表，不会再动态获取需同步列表（黑白名单机制依旧生效），如“repo1,repo2,repo3”。
force_update 默认为 false, 配置后，启用 git push -f 强制同步，注意：开启后，会强制覆盖目的端仓库。
debug 默认为 false, 配置后，启用 debug 开关，会显示所有执行命令。