一款实用的 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

目录
相关文章
|
4月前
|
Shell 网络安全 开发工具
Github Pages + Jekyll 独立博客一小时快速搭建&上线指南
Github Pages + Jekyll 独立博客一小时快速搭建&上线指南
|
4月前
GitHub和Gitee的基本使用和在IDEA中的集成
GitHub和Gitee的基本使用和在IDEA中的集成
59 0
|
4月前
|
前端开发
Github项目分享——免费的画图工具drow,最新前端面试题整理
Github项目分享——免费的画图工具drow,最新前端面试题整理
|
11天前
|
Java Spring 传感器
AI 浪潮席卷,Spring 框架配置文件管理与环境感知,为软件稳定护航,你还在等什么?
【8月更文挑战第31天】在软件开发中,配置文件管理至关重要。Spring框架提供强大支持,便于应对不同环境需求,如电商项目的开发、测试与生产环境。它支持多种格式的配置文件(如properties和YAML),并能根据环境加载不同配置,如数据库连接信息。通过`@Profile`注解可指定特定环境下的配置生效,同时支持通过命令行参数或环境变量覆盖配置值,确保应用稳定性和可靠性。
25 0
|
11天前
|
开发者 存储 API
Xamarin 开发者的社区资源概览:从官方文档到GitHub示例,全面探索提升开发技能与解决问题的多元化渠道与实用工具
【8月更文挑战第31天】Xamarin 开发者社区资源概览旨在提升开发效率与解决问题,涵盖官方文档、社区论坛、GitHub 项目等。官方文档详尽,涵盖 Xamarin.Forms 使用、性能优化等;社区论坛供交流心得;GitHub 提供示例代码。此外,第三方博客、视频教程及 Xamarin University 等资源也丰富多样,适合各阶段开发者学习与提升。通过综合利用这些资源,开发者可不断进步,应对技术挑战。
26 0
|
2月前
|
人工智能 分布式计算 BI
透视开源生态,OSGraph——GitHub全域数据图谱的智能洞察工具
【7月更文挑战第5天】透视开源生态,OSGraph——GitHub全域数据图谱的智能洞察工具
透视开源生态,OSGraph——GitHub全域数据图谱的智能洞察工具
|
14天前
|
Devops 持续交付 开发者
.NET自动化之旅:是Azure DevOps还是GitHub Actions能够打造完美的CI/CD流水线?
【8月更文挑战第28天】在现代软件开发中,持续集成(CI)与持续部署(CD)是提升代码质量和加速交付的关键实践。对于 .NET 应用,Azure DevOps 和 GitHub Actions 等工具可高效构建 CI/CD 流水线,提升开发效率并确保软件稳定可靠。Azure DevOps 提供一站式全流程管理,支持 YAML 定义的自动化构建、测试和部署;GitHub Actions 则以简洁灵活著称,适用于 .NET 项目的自动化流程。选择合适的工具可显著提高开发效率并确保高质量标准。
10 0
|
25天前
|
数据采集 JSON 小程序
零成本 API 服务搭建,用 GitHub Actions 自动爬取文章?
本着将成本降到最低,我目前做的应用或小程序都是单机的,也就是不用请求接口,只要一上架就没有任何支出。但是写死的数据毕竟有限,应用的内容单一无法紧跟时事热点,每次打开一个样,自然就没有留存。遇到有错字啥还要更新版本,那有没有方法既能丰富应用内容,又不用增加成本呢?
11 0
|
29天前
GitHub——使用GitHub Pages生成在线文档
GitHub——使用GitHub Pages生成在线文档
8 0
|
29天前
|
存储 开发工具 数据安全/隐私保护
解决Gitee或者Github出现Access denied fatal: unable to access,The requested URL returned error: 403
解决Gitee或者Github出现Access denied fatal: unable to access,The requested URL returned error: 403
83 0