Gitee Pages Action 使用教程

1. 项目介绍

Gitee Pages Action 是一个用于自动部署 Gitee Pages 的开源项目。Gitee Pages 是 Gitee 提供的一项静态网页托管服务，类似于 GitHub Pages。然而，Gitee Pages 不像 GitHub Pages 那样，每次提交代码后会自动更新 Pages 内容，除非你购买了 Gitee Pages Pro 服务。Gitee Pages Action 就是为了解决这个问题而开发的，它可以在 GitHub 上配置一个工作流，自动将代码同步到 Gitee 并触发 Gitee Pages 的更新。

2. 项目快速启动

2.1 配置 GitHub 仓库

首先，你需要在 GitHub 仓库中配置 Gitee Pages Action。以下是具体步骤：

1. 创建 GitHub 仓库：如果你还没有 GitHub 仓库，请先创建一个。

2. 配置 SSH 密钥：

   • 在本地生成 SSH 密钥对：

     ssh-keygen -t rsa -C "[e-mail]"
     

   • 将生成的公钥 id_rsa.pub 添加到 GitHub 和 Gitee 的 SSH 配置中。

3. 配置 GitHub Secrets：

   • 在 GitHub 仓库的 Settings -> Secrets 中添加以下两个密钥：
     • GITEE_RSA_PRIVATE_KEY：存放 id_rsa 私钥的内容。
     • GITEE_PASSWORD：存放你的 Gitee 账户密码。

2.2 创建 GitHub Actions 工作流

在 GitHub 仓库的 .github/workflows/ 目录下创建一个新的 YAML 文件，例如 sync.yml，内容如下：

name: Sync

on:
  push:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Sync to Gitee
      uses: wearerequired/git-mirror-action@master
      env:
        SSH_PRIVATE_KEY: ${{ secrets.GITEE_RSA_PRIVATE_KEY }}
      with:
        source-repo: "[e-mail]:your_username/your_repo.git"
        destination-repo: "[e-mail]:your_username/your_repo.git"

    - name: Build Gitee Pages
      uses: yanglbme/gitee-pages-action@main
      with:
        gitee-username: your_username
        gitee-password: ${{ secrets.GITEE_PASSWORD }}
        gitee-repo: your_username/your_repo
        branch: main

2.3 首次手动部署 Gitee Pages

由于 Gitee Pages 的首次部署需要手动操作，请登录 Gitee 并手动启动 Gitee Pages 服务。

3. 应用案例和最佳实践

3.1 个人博客自动部署

许多开发者使用 Gitee Pages 来托管个人博客。通过配置 Gitee Pages Action，每次在 GitHub 上更新博客内容后，Gitee Pages 会自动更新，确保国内用户能够快速访问最新的博客内容。

3.2 开源项目国内镜像

对于一些开源项目，开发者可能会选择在 Gitee 上创建一个镜像仓库，以便国内用户能够更快地访问项目文档和代码。通过 Gitee Pages Action，可以自动同步 GitHub 上的更新到 Gitee，并自动部署 Gitee Pages。

4. 典型生态项目

4.1 Doocs 技术社区

Doocs 技术社区是一个专注于技术分享的开源社区，其多个项目使用了 Gitee Pages Action 来实现 GitHub 和 Gitee 的同步部署。例如，doocs/jvm 项目通过 Gitee Pages Action 自动部署 Gitee Pages，方便国内开发者访问。

4.2 AntV 数据可视化

AntV 是蚂蚁金服开源的数据可视化解决方案，其多个子项目也使用了 Gitee Pages Action 来同步 GitHub 和 Gitee 的文档和示例代码，确保国内用户能够快速访问最新的文档和示例。

通过以上步骤，你可以轻松实现 Gitee Pages 的自动部署，提升项目的国内访问速度和用户体验。