GitHub Actions 实现仓库自动同步 Gitee 并更新文档：流水线打造高效协作

2023-10-20 19:35:55

前言

在当今快节奏的软件开发中，协作和文档更新至关重要。GitHub Actions 作为一款功能强大的自动化工具，可以帮助我们简化和优化这一流程。本文将详细介绍如何利用 GitHub Actions 实现仓库自动同步 Gitee 并更新文档，从而建立一个高效的协作环境。

背景

开源项目 https://github.com/CatsAndMice/medash 的文档托管在 Gitee Pages 上。每次代码提交或文档更新后，都需要手动将更改推送到 Gitee 并更新文档。这个过程繁琐且容易出错。

解决方案：使用 GitHub Actions

GitHub Actions 是一款基于事件驱动的自动化工具，可让开发人员在 GitHub 上创建自定义的工作流。利用 GitHub Actions，我们可以创建一个流水线，来自动执行仓库同步和文档更新任务。

设置仓库同步

在 GitHub 仓库中创建 .github/workflows 目录。
在该目录下创建一个名为 sync-to-gitee.yml 的 YAML 文件。
在文件中添加以下内容：

name: Sync to Gitee

on:
  push:
    branches: [main]

jobs:
  sync-to-gitee:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: mr-smithers-excellent/gitee-actions@v1.1.0
        with:
          access_token: ${{ secrets.GITEE_ACCESS_TOKEN }}
          repository: CatsAndMice/medash
          sync_branches: [main]

将 GITEE_ACCESS_TOKEN 替换为你的 Gitee 个人访问令牌。

设置文档更新

在 .github/workflows 目录中创建一个名为 update-docs.yml 的 YAML 文件。
在文件中添加以下内容：

name: Update Docs

on:
  push:
    branches: [main]

jobs:
  update-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: peaceiris/actions-gh-pages@v3
        with:
          publish_dir: ./docs
          force_orphan: true