开源软件名称：

gitee-pages-action

开源软件地址：

https://gitee.com/yanglbme/gitee-pages-action

开源软件介绍：

Gitee Pages Action

由于 Gitee Pages 的访问速度很快，很多朋友会选择 Gitee Pages 部署项目（如：个人博客、开源项目国内镜像站点）。但是它不像 GitHub Pages 那样，一提交代码就能自动更新 Pages，因为 Gitee 的自动部署属于 Gitee Pages Pro 的服务。

为了实现 Gitee Pages 的自动部署，我开发了 Gitee Pages Action ，只需要在 GitHub 项目的 Settings 页面下配置 keys，然后在 .github/workflows/ 下创建一个工作流，引入一些配置参数即可。欢迎 Star ⭐ 关注本项目。

欢迎体验，若有使用上的问题，也欢迎随时提交 Issues 反馈。

注：首次需要手动登录 Gitee ，点击“启动”进行 Gitee Pages 服务的部署。

入参

参数	描述	是否必传	默认值	示例
`gitee-username`	Gitee 用户名	是	-	`yanglbme`
`gitee-password`	Gitee 密码	是	-	`${{ secrets.GITEE_PASSWORD }}`
`gitee-repo`	Gitee 仓库（严格区分大小写）	是	-	`doocs/leetcode`
`branch`	要部署的分支（分支必须存在）	否	`master`	`main`
`directory`	要部署的分支上的目录	否		`src`
`https`	是否强制使用 HTTPS	否	`true`	`false`

完整示例

1. 创建 workflow

在你的 GitHub 项目 .github/workflows/ 文件夹下创建一个 .yml 文件，如 sync.yml，内容如下：

name: Syncon:  push:    branches: [main]  workflow_dispatch:jobs:  build:    runs-on: ubuntu-latest    steps:      - name: Sync to Gitee        uses: wearerequired/git-mirror-action@master        env:          # 注意在 Settings->Secrets 配置 GITEE_RSA_PRIVATE_KEY          SSH_PRIVATE_KEY: ${{ secrets.GITEE_RSA_PRIVATE_KEY }}        with:          # 注意替换为你的 GitHub 源仓库地址          source-repo: [email protected]:doocs/leetcode.git          # 注意替换为你的 Gitee 目标仓库地址          destination-repo: [email protected]:Doocs/leetcode.git      - name: Build Gitee Pages        uses: yanglbme/gitee-pages-action@main        with:          # 注意替换为你的 Gitee 用户名          gitee-username: yanglbme          # 注意在 Settings->Secrets 配置 GITEE_PASSWORD          gitee-password: ${{ secrets.GITEE_PASSWORD }}          # 注意替换为你的 Gitee 仓库，仓库名严格区分大小写，请准确填写，否则会出错          gitee-repo: doocs/leetcode          # 要部署的分支，默认是 master，若是其他分支，则需要指定（指定的分支必须存在）          branch: main

先使用 wearerequired/git-mirror-action 将 GitHub 仓库同步到 Gitee 仓库，再使用 yanglbme/gitee-pages-action 实现 Gitee Pages 的自动部署。

2. 配置密钥

密钥的配置步骤如下（可展开看示例图）：

a. 在命令行终端或 Git Bash 使用命令 ssh-keygen -t rsa -C "[email protected]" 生成 SSH Key，注意替换为自己的邮箱。生成的 id_rsa 是私钥，id_rsa.pub 是公钥。(⚠️注意此处不要设置密码，生成的公私钥用于下面 GitHub / Gitee 的配置，以保证公私钥成对，否则从 GitHub -> Gitee 的同步将会失败。)

b. 在 GitHub 项目的「Settings -> Secrets」路径下配置好命名为 GITEE_RSA_PRIVATE_KEY 和 GITEE_PASSWORD 的两个密钥。其中：GITEE_RSA_PRIVATE_KEY 存放 id_rsa 私钥；GITEE_PASSWORD 存放 Gitee 帐号的密码。

c. 在 GitHub 的个人设置页面「Settings -> SSH and GPG keys」配置 SSH 公钥（即：id_rsa.pub），命名随意。

d. 在 Gitee 的个人设置页面「安全设置 -> SSH 公钥」配置 SSH 公钥（即：id_rsa.pub），命名随意。

3. 运行结果

如果一切配置正常，并成功触发 Gitee Pages Action ，Gitee Pages Action 会打印出成功的结果。并且，我们会在 Gitee 公众号收到一条登录通知。这是 Gitee Pages Action 程序帮我们登录到 Gitee 官网，并为我们点击了项目的部署按钮。

Run yanglbme/gitee-pages-action@main  with:    gitee-username: yanglbme    gitee-password: ***    gitee-repo: doocs/leetcode    branch: main    https: true/usr/bin/docker run --name e28490f27de0ee43bb49109a40cea0e43202d2_d4911a --label e28490 --workdir /github/workspace --rm -e INPUT_GITEE-USERNAME -e INPUT_GITEE*** INPUT_GITEE-REPO -e INPUT_BRANCH -e INPUT_DIRECTORY -e INPUT_HTTPS -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_REF_NAME -e GITHUB_REF_PROTECTED -e GITHUB_REF_TYPE -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e RUNNER_OS -e RUNNER_ARCH -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/leetcode/leetcode":"/github/workspace" e28490:f27de0ee43bb49109a40cea0e43202d2[2021-11-27 20:16:30] Welcome to use Gitee Pages Action ❤