gitee-pages-action

gitee-pages-action

GitHub Action实现Gitee Pages自动部署

该GitHub Action用于自动部署Gitee Pages。开发者可在GitHub项目中配置工作流,实现代码推送后自动更新Gitee Pages。Action支持设置Gitee账户信息和仓库参数,并附有使用指南和常见问题解答。这一工具简化了Gitee Pages的部署流程,提升了开发效率。

Gitee Pages ActionGitHub Actions自动部署静态网站持续集成Github开源项目
<p align="center"> <a href="https://github.com/yanglbme/gitee-pages-action"> <img src="./images/logo.png" alt="gitee-pages-action"> </a> </p> <p align="center"> <a href="./LICENSE"><img src="https://img.shields.io/github/license/yanglbme/gitee-pages-action?color=42b883&style=flat-square" alt="license"></a> <a href="../../releases"><img src="https://img.shields.io/github/v/release/yanglbme/gitee-pages-action?color=42b883&style=flat-square" alt="release"></a> <a href="#谁在使用"><img src="https://shields.io/badge/who's-using-42b883?style=flat-square" alt="users"></a> <a href="#错误及解决方案"><img src="https://shields.io/badge/faq-here-42b883?style=flat-square" alt="users"></a> <a href="https://github.com/yanglbme/gitee-pages-action"><img src="https://shields.io/badge/%E2%AD%90-GitHub-42b883?style=flat-square" alt="github"></a> <a href="https://gitee.com/yanglbme/gitee-pages-action"><img src="https://shields.io/badge/%E2%AD%90-Gitee-42b883?style=flat-square" alt="gitee"></a><br> <a href="https://github.com/yanglbme/gitee-pages-action/stargazers"><img src="https://img.shields.io/github/stars/yanglbme/gitee-pages-action?color=42b883&logo=github&style=flat-square" alt="stars"></a> <a href="https://github.com/yanglbme/gitee-pages-action/network/members"><img src="https://img.shields.io/github/forks/yanglbme/gitee-pages-action?color=42b883&logo=github&style=flat-square" alt="forks"></a> </p> <h1 align="center">Gitee Pages Action</h1>

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

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

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

注:

  1. 首次需要手动登录 Gitee ,点击“启动”进行 Gitee Pages 服务的部署。
  2. 由于 Gitee 改版,使用 Gitee Pages 前需要先完成实名认证。

入参

参数描述是否必传默认值示例
gitee-usernameGitee 用户名-yanglbme
gitee-passwordGitee 密码-${{ secrets.GITEE_PASSWORD }}
gitee-repoGitee 仓库(严格区分大小写)-doocs/leetcode
branch要部署的分支(分支必须存在)mastermain
directory要部署的分支上的目录src
https是否强制使用 HTTPStruefalse

完整示例

1. 创建 workflow

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

name: Sync on: 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: git@github.com:doocs/leetcode.git # 注意替换为你的 Gitee 目标仓库地址 destination-repo: git@gitee.com: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

注:

  1. 这里我先使用 wearerequired/git-mirror-action 将 GitHub 仓库同步到 Gitee 仓库,再使用 yanglbme/gitee-pages-action 实现 Gitee Pages 的自动部署。如果你已经通过其它的方式,将代码 push 至 Gitee 了,那么可以不使用 wearerequired/git-mirror-action,也不需要配置 GITEE_RSA_PRIVATE_KEY
  2. branch 参数默认是 master,如果你是部署在 gh-pages(或者 main) 分支等等,务必指定 branch: gh-pages(或者 branch: main)。
  3. branch 对应的分支,必须在仓库中实际存在,请不要随意(不)指定分支,否则可能导致 Gitee Pages 站点出现 404 无法访问的情况。
  4. 对于 gitee-repo 参数,如果你的项目在 Gitee 的地址为 https://gitee.com/用户名/xxx ,那么 gitee-repo 就填写为 用户名/xxx#54
  5. 对于 workflow 的触发事件,你可以根据项目实际情况,指定为其它的触发事件。比如:
    on: push: branches: [main, master]
    更多触发事件,请参考 Events that trigger workflows

2. 配置密钥

密钥的配置步骤如下(可展开看示例图):

<details> <summary>a. 在命令行终端或 Git Bash 使用命令 <code>ssh-keygen -t rsa -C "youremail@example.com"</code> 生成 SSH Key,注意替换为自己的邮箱。生成的 <code>id_rsa</code> 是私钥,<code>id_rsa.pub</code> 是公钥。(⚠️注意此处不要设置密码,生成的公私钥用于下面 GitHub / Gitee 的配置,以保证公私钥成对,否则从 GitHub -> Gitee 的同步将会失败。)</summary> <img src="./images/gen_ssh_key.png" alt="gen_ssh_key"> </details> <details> <summary>b. 在 GitHub 项目的「Settings -> Secrets」路径下配置好命名为 <code>GITEE_RSA_PRIVATE_KEY</code> 和 <code>GITEE_PASSWORD</code> 的两个密钥。其中:<code>GITEE_RSA_PRIVATE_KEY</code> 存放 <code>id_rsa</code> 私钥;<code>GITEE_PASSWORD</code> 存放 Gitee 帐号的密码。</summary> <img src="./images/add_secrets.png" alt="add_secrets"> </details> <details> <summary>c. 在 GitHub 的个人设置页面「<a href="https://github.com/settings/keys">Settings -> SSH and GPG keys</a>」配置 SSH 公钥(即:<code>id_rsa.pub</code>),命名随意。</summary> <img src="./images/add_ssh_key_github.png" alt="add_ssh_key_github"> </details> <details> <summary>d. 在 Gitee 的个人设置页面「<a href="https://gitee.com/profile/sshkeys">安全设置 -> SSH 公钥</a>」配置 SSH 公钥(即:<code>id_rsa.pub</code>),命名随意。</summary> <img src="./images/add_ssh_key_gitee.png" alt="add_ssh_key_gitee"> </details>

3. 关注 Gitee 公众号

关注 Gitee 官方公众号,并绑定个人 Gitee 帐号,用于接收帐号登录通知、以及绕过短信验证码校验,见错误及解决方案 第 3 点。

4. 运行结果

如果一切配置正常,并成功触发 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 ❤ 📕 Getting Started Guide: https://github.com/marketplace/actions/gitee-pages-action 📣 Maintained by Yang Libin: https://github.com/yanglbme [2021-11-27 20:16:34] Login successfully [2021-11-27 20:16:35] Rebuild Gitee Pages successfully [2021-11-27 20:16:35] Success, thanks for using @yanglbme/gitee-pages-action!
<img src="./images/action.png" alt="action_result"> <img src="./images/wechat_notification.jpg" alt="add_ssh_key_gitee" style="width: 750px; height: 1334px;" />

错误及解决方案

#错误解决方案
1Error: Wrong username or password, login failed .帐号或密码错误,请检查参数 gitee-usernamegitee-password是否准确配置。
2Error: Need captcha validation, please visit https://gitee.com/login, login to validate your account.需要图片验证码校验。可以手动登录 Gitee 官方,校验验证码。
3Error: Need phone captcha validation, please follow wechat official account "Gitee" to bind account to turn off authentication.需要短信验证码校验。可以关注 Gitee 微信公众号,并绑定 Gitee 帐号,接收登录提示。#6
4Error: Do not deploy frequently, try again one minute later.短期内频繁部署 Gitee Pages 导致,可以稍后再触发自动部署。
5Error: Deploy error occurred, please re-run job or check your input gitee-repo.gitee-repo 参数格式如:doocs/leetcode,并且严格区分大小写,请准确填写。#10
6Error: Unknown error occurred in login method, resp: ...登录出现未知错误,请在 issues 区反馈。
7Error: Rebuild page error, status code: xxx更新 Pages 时状态码异常,请尝试再次触发 Action 执行。也可能为 gitee pages 未初始化,第一次需要手动部署 gitee pages。
8Error: HTTPSConnectionPool(host='gitee.com', port=443): Read timed out. (read timeout=6)<br><br>Error: HTTPSConnectionPool(host='gitee.com', port=443): Max retries exceeded with url: /login (Caused by ConnectTimeoutError(<urllib3.connection.HTTPSConnection object at 0x7f6c889d42e8>, 'Connection to gitee.com timed out. (connect timeout=6)'))网络请求出错,请尝试 Re-run jobs 。#27
9Error: The repository owner is not authenticated and is not allowed to deploy pages services.仓库持有者未实名认证,不允许部署 pages 服务。
10git@github.com: Permission denied (publickey).<br>fatal: Could not read from remote repository.<br>Please make sure you have the correct access rights and

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多