一款实用的 GitHub Actions 小工具:Gitee Pages Actions

简介: 使用 GitHub Pages 时,每当项目有更新,GitHub 会自动帮我们重新部署 GitHub Pages。对于国内的 Gitee Pages,一般情况下无法自动部署,除非我们开通 Gitee Pages Pro 功能。而 Pro 功能的开通,需要满足以下其中一个条件

使用 GitHub Pages 时,每当项目有更新,GitHub 会自动帮我们重新部署 GitHub Pages。对于国内的 Gitee Pages,一般情况下无法自动部署,除非我们开通 Gitee Pages Pro 功能。而 Pro 功能的开通,需要满足以下其中一个条件:


花钱开通 Pro 功能,¥ 99/年。


Gitee 项目足够优秀,得到 Gitee 官方的推荐,那么 Gitee 就会提示“您的项目为推荐项目,已自动为您开通 Gitee Pages Pro”。


为了帮助更多朋友实现 Gitee Pages 的自动部署,我开发了 Gitee Pages Action[1],只需要在项目的 Settings 页面下配置 keys,然后在 .github/workflows/ 下创建一个工作流,引入一些配置参数即可。


目前,Doocs 旗下的多个仓库都使用了 Gitee Pages Action 成功进行自动部署,如:jvm[2], advanced-java[3]。若有使用上的问题,可以直接在文章底下评论区留言,也可以到 Issues[4] 区反馈。


注:首次需要手动登录 Gitee 点击构建。


项目地址


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


0.png


入参


参数 描述 是否必传 默认值
gitee-username Gitee 用户名 -
gitee-password Gitee 密码 -
gitee-repo Gitee 仓库 -
branch 构建的分支 master
directory 构建的目录 ''
https 是否强制 HTTPS true


示例


以下是一个完整示例。


在你的 GitHub 仓库 .github/workflows/ 文件夹下创建一个 sync.yml 文件,内容如下:


name: Sync
on:  push:    branches: [ master ]
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: "git@github.com:doocs/advanced-java.git"          # 注意替换为你的 Gitee 目标仓库地址          destination-repo: "git@gitee.com:Doocs/advanced-java.git"
    - name: Build Gitee Pages      uses: yanglbme/gitee-pages-action@master      with:          # 注意替换为你的 Gitee 用户名          gitee-username: yanglbme          # 注意在 Settings->Secrets 配置 GITEE_PASSWORD          gitee-password: ${{ secrets.GITEE_PASSWORD }}          # 注意替换为你的 Gitee 仓库          gitee-repo: doocs/advanced-java


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


请确保在 GitHub 项目的 Settings -> Secrets 路径下配置好 GITEE_RSA_PRIVATE_KEY 以及 GITEE_PASSWORD 两个密钥。其中:


GITEE_RSA_PRIVATE_KEY: 存放你的 id_rsa 私钥。

GITEE_PASSWORD: 存放你的 Gitee 账户密码。


1.png


如果一切配置正常,并成功触发 Gitee Pages Action,我们可能会收到一封来自 Gitee 的告警邮件/站内信。放心,这是 GitHub Action 程序帮我们登录到 Gitee 官网,并为我们点击了项目的部署按钮。


2.png


引用链接


[1] Gitee Pages Action: https://github.com/marketplace/actions/gitee-pages-action


[2] jvm: https://github.com/doocs/jvm/blob/master/.github/workflows/sync.yml


[3] advanced-java: https://github.com/doocs/advanced-java/blob/master/.github/workflows/sync.yml


[4] Issues: https://github.com/yanglbme/gitee-pages-action/issues

目录
相关文章
|
2月前
|
网络协议 Linux Android开发
解决GitHub无法访问的问题:手动修改hosts文件与使用SwitchHosts工具
解决GitHub无法访问的问题:手动修改hosts文件与使用SwitchHosts工具
142 1
|
2月前
|
Shell 网络安全 开发工具
Github Pages + Jekyll 独立博客一小时快速搭建&上线指南
Github Pages + Jekyll 独立博客一小时快速搭建&上线指南
79 1
|
2月前
GitHub和Gitee的基本使用和在IDEA中的集成
GitHub和Gitee的基本使用和在IDEA中的集成
29 0
|
1月前
|
存储 安全 Serverless
用 Github Actions 自动部署阿里云函数计算 FC
介绍了如何配置阿里云函数计算(FC)与GitHub Actions集成以实现自动部署。首先在阿里云创建函数,然后在项目根目录创建`s.yaml`文件配置Serverless Devs。接着在GitHub仓库中设置 Secrets 存储阿里云账号信息,并创建名为`aliyun-fc-deploy.yaml`的工作流文件来定义GitHub Actions。当代码推送到`master`分支时,Actions会自动部署到函数计算。最后,成功配置后,提交代码会触发自动部署,并可在GitHub Actions和阿里云控制台查看部署状态。
441 3
|
3月前
|
安全 Shell 网络安全
Git学习---Git快速入门、Git基础使用、Git进阶使用、Git服务器使用(IDEA集成GitHub、Gitee、GitLab)、GitHub Desktop客户端
Git学习---Git快速入门、Git基础使用、Git进阶使用、Git服务器使用(IDEA集成GitHub、Gitee、GitLab)、GitHub Desktop客户端
136 0
|
3月前
|
网络安全
github或gitee配置ssh
github或gitee配置ssh
24 0
|
4月前
|
存储
github pages 部署单页面
github pages 部署单页面
56 0
|
4月前
|
JavaScript Ubuntu 网络安全
使用github actions,将私有仓库的构建文件发布到另一个公开仓库,并同步到gitee
使用github actions,将私有仓库的构建文件发布到另一个公开仓库,并同步到gitee
113 0
|
4月前
|
缓存 网络协议 CDN
Docsify 配合 Github Pages 搭建一个自己的云笔记
Docsify 配合 Github Pages 搭建一个自己的云笔记
103 0
|
程序员 开发工具 C#
如何将一个项目同时提交到GitHub和Gitee(码云)上
如何将一个项目同时提交到GitHub和Gitee(码云)上
474 0
如何将一个项目同时提交到GitHub和Gitee(码云)上