https://github.com/Yikun/hub-mirror-action

一个Github Action，用于在Github和Gitee之间同步代码。Action for mirroring repos between Hubs (like Github and Gitee).
https://github.com/Yikun/hub-mirror-action

Last synced: about 2 months ago
JSON representation

一个Github Action，用于在Github和Gitee之间同步代码。Action for mirroring repos between Hubs (like Github and Gitee).

• Host: GitHub
• URL: https://github.com/Yikun/hub-mirror-action
• Owner: Yikun
• License: mit
• Created: 2020-01-16T12:11:34.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-26T09:58:49.000Z (5 months ago)
• Last Synced: 2024-05-29T23:18:32.198Z (4 months ago)
• Language: Python
• Homepage:
• Size: 132 KB
• Stars: 608
• Watchers: 8
• Forks: 162
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hub Mirror Action

简体中文 | [English](./README_en.md)

一个用于在hub间（例如Github，Gitee）账户代码仓库同步的action

## 用法

```yaml

steps:

- name: Mirror the Github organization repos to Gitee.

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/kunpengcompute

    dst: gitee/kunpengcompute

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    account_type: org

    # src_account_type: org

    # dst_account_type: org

```

上面的配置完成了kunpencompute组织从github到gitee的同步，你可以在[测试和demo](https://github.com/Yikun/hub-mirror-action/tree/master/.github/workflows)找到完整用法。

有疑问、想法、问题、建议，可以通过[![Gitter](https://badges.gitter.im/hub-mirror-action/community.svg)](https://gitter.im/hub-mirror-action/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)找到我们。

## 谁在使用？

超过[100+](https://github.com/search?p=2&q=hub-mirror-action+%22account_type%22+%22org%22&type=Code)组织，[4000+](https://github.com/search?l=YAML&q=%22hub-mirror-action%22&type=Code)使用者正在使用，[50+](https://github.com/search?l=Markdown&q=%22hub-mirror-action%22&type=code)来自使用者的使用教程：

          

## 参数详解

#### 必选参数

- `src` 需要被同步的源端账户名，如github/kunpengcompute，表示Github的kunpengcompute账户。

- `dst` 需要同步到的目的端账户名，如gitee/kunpengcompute，表示Gitee的kunpengcompute账户。

- `dst_key` 用于在目的端上传代码的私钥(默认可以从~/.ssh/id_rsa获取），可参考[生成/添加SSH公钥](https://gitee.com/help/articles/4181)或[generating SSH keys](https://docs.github.com/articles/generating-an-ssh-key/)生成，并确认对应公钥已经被正确配置在目的端。对应公钥，Github可以在[这里](https://github.com/settings/keys)配置，Gitee可以[这里](https://gitee.com/profile/sshkeys)配置。

- `dst_token` 创建仓库的API tokens， 用于自动创建不存在的仓库，Github可以在[这里](https://github.com/settings/tokens)找到，Gitee可以在[这里](https://gitee.com/profile/personal_access_tokens)找到。

#### 可选参数

- `account_type` 默认为user，源和目的的账户类型，可以设置为org（组织）或者user（用户），该参数支持**同类型账户**（即组织到组织，或用户到用户）的同步。如果源目的仓库是不同类型，请单独使用`src_account_type`和`dst_account_type`配置。

- `src_account_type` 默认为`account_type`，源账户类型，可以设置为org（组织）或者user（用户）。

- `dst_account_type` 默认为`account_type`，目的账户类型，可以设置为org（组织）或者user（用户）。

- `clone_style` 默认为https，可以设置为ssh或者https。当设置为ssh时，你需要将`dst_key`所对应的公钥同时配置到源端和目的端。

- `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开关，会显示所有执行命令。

- `timeout` 默认为'30m', 用于设置每个git命令的超时时间，'600'=>600s, '30m'=>30 mins, '1h'=>1 hours

- `mappings` 源仓库映射规则，比如'A=>B, C=>CC', A会被映射为B，C会映射为CC，映射不具有传递性。主要用于源和目的仓库名不同的镜像。

- `lfs` 提供[git lfs](https://git-lfs.com/)支持, 默认为false, 配置为true后，调用`git lfs fetch --all`和`git lfs push --all`进行同步。

## 举些例子

#### 组织同步

同步Github的kunpengcompute组织到Gitee

```yaml

- name: Organization mirror

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/kunpengcompute

    dst: gitee/kunpengcompute

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    account_type: org

```

#### 黑/白名单

动态获取源端github/Yikun的repos，但仅同步名为hub-mirror-action，不同步hashes这个repo到Gitee

```yaml

- name: Single repo mirror

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    white_list: "hub-mirror-action"

    black_list: "hashes"

```

#### 静态名单（可用于单一仓库同步）

不会动态获取源端github/Yikun的repos，仅同步hub-mirror-action这个repo

```yaml

- name: Black list

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    static_list: "hub-mirror-action"

```

#### clone方式

使用ssh方式进行clone

说明：请把`dst_key`所的公钥配置到源端（在这里为github）及目的端（在这里为gitee）

```yaml

- name: ssh clone style

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    clone_style: "ssh"

```

#### 指定目录cache

```yaml

- name: Mirror with specific cache

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    cache_path: /github/workspace/hub-mirror-cache

```

#### 强制更新，并打开debug日志开关

```yaml

- name: Mirror with force push (git push -f)

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    force_update: true

    debug: true

```

#### 设置命令行超时时间为1小时

```yaml

- name: Mirror with force push (git push -f)

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    force_update: true

    timeout: '1h'

```

#### 仓库名不同时同步（github/yikun/yikun.github.com to gitee/yikunkero/blog）

```yaml

- name: mirror with mappings

  uses: Yikun/hub-mirror-action@mappings

  with:

    src: github/yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    mappings: "yikun.github.com=>blog"

    static_list: "yikun.github.com"

```

#### 仅同步非fork且非private的仓库

```yaml

- name: Get repository list exclude private and fork

  id: repo

  uses: yi-Xu-0100/[email protected]

- name: Mirror repository list exclude private and fork

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    static_list: ${{ steps.repo.outputs.repoList }}

```

#### 支持LFS同步

```yaml

- name: Mirror with lfs (git lfs fetch/push --all)

  uses: Yikun/hub-mirror-action@master

  with:

    src: github/Yikun

    dst: gitee/yikunkero

    dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}

    dst_token: ${{ secrets.GITEE_TOKEN }}

    lfs: true

```

## FAQ

- 如何在secrets添加dst_token和dst_key？

  下面是添加secrets的方法，也可以参考[secrets官方文档](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)了解更多：

  1. **获取Token和Key**，分别获取[ssh key](https://gitee.com/profile/sshkeys)和[token](https://gitee.com/profile/personal_access_tokens)。

  2. **增加Secrets配置**，在配置仓库的Setting-Secrets中新增Secrets，例如GITEE_PRIVATE_KEY、GITEE_TOKEN

  3. **在Workflow中引用**， 可以用过类似`${{ secrets.GITEE_PRIVATE_KEY }}`来访问

## 参考

- [Hub mirror template](https://github.com/yi-Xu-0100/hub-mirror): 一个用于展示如何使用这个action的模板仓库. from @yi-Xu-0100

- [自动镜像 GitHub 仓库到 Gitee](https://github.com/ShixiangWang/sync2gitee): 一个关于如何使用这个action的介绍. from @ShixiangWang

- [巧用Github Action同步代码到Gitee](http://yikun.github.io/2020/01/17/%E5%B7%A7%E7%94%A8Github-Action%E5%90%8C%E6%AD%A5%E4%BB%A3%E7%A0%81%E5%88%B0Gitee/): Github Action第一篇软文

## 最后

如果觉得不错，**来个star**支持下作者吧！你的Star是我更新代码的动力！：）

想任何想吐槽或者建议的都可以直接飞个[issue](https://github.com/Yikun/hub-mirror-action/issues).