首页
/ gitee-pages-action 的安装和配置教程

gitee-pages-action 的安装和配置教程

2025-05-06 21:16:48作者:舒璇辛Bertina

1. 项目的基础介绍和主要的编程语言

gitee-pages-action 是一个开源项目,它可以帮助用户在 Gitee 平台上自动化部署静态网站。该项目主要使用 GitHub Actions 作为自动化工作流的引擎,通过简单的配置,即可实现每当代码推送至 Gitee 仓库时,自动构建并发布静态网站到 Gitee Pages。

该项目主要使用的是 Go 语言编写,同时也涉及到一些 Shell 脚本的使用。

2. 项目使用的关键技术和框架

  • GitHub Actions: 是 GitHub 提供的持续集成和持续部署(CI/CD)服务,允许你为你的仓库自动化你的软件开发工作流程。
  • Gitee Pages: 是 Gitee 提供的静态网站托管服务,允许你将个人或组织的静态网站免费托管在 Gitee 上。
  • Go 语言: 项目主要使用 Go 语言编写,Go 是一种静态类型、编译型和并发型语言,适用于构建简单、高效的软件。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装和配置 gitee-pages-action 之前,你需要做一些准备工作:

  • 确保你有一个 Gitee 账号,并且已经创建了一个仓库。
  • 安装并配置了 Git。
  • 确保你的 Gitee 仓库已经启用了 Gitee Pages 功能。
  • 在 Gitee 上生成一个个人访问令牌(Personal Access Token),用于 GitHub Actions 访问你的 Gitee 仓库。

安装步骤

以下是小白级的安装步骤:

  1. 克隆仓库
    首先,你需要将 gitee-pages-action 项目克隆到本地:

    git clone https://github.com/yanglbme/gitee-pages-action.git
    cd gitee-pages-action
    
  2. 配置 GitHub Secrets
    在你的 GitHub 仓库中,进入仓库的设置页面,找到 Secrets 和 Variables 部分,添加以下两个变量:

    • GITEE_TOKEN:你的 Gitee 个人访问令牌。
    • GITEE_REPO:你的 Gitee 仓库名称,格式为 用户名/仓库名
  3. 创建 GitHub Actions 工作流文件
    在你的 GitHub 仓库的根目录下,创建一个名为 .github/workflows 的文件夹,并在该文件夹中创建一个名为 gitee-pages.yml 的工作流文件。文件内容如下:

    name: Gitee Pages
    
    on:
      push:
        branches:
          - main # 你的分支名称
    
    jobs:
      deploy:
        runs-on: ubuntu-latest
        steps:
          - name: Checkout
            uses: actions/checkout@v2
    
          - name: Setup Go
            uses: actions/setup-go@v2
            with:
              go-version: '1.15'
    
          - name: Deploy to Gitee Pages
            uses: yanglbme/gitee-pages-action@master
            with:
              GITEE_TOKEN: ${{ secrets.GITEE_TOKEN }}
              GITEE_REPO: ${{ secrets.GITEE_REPO }}
              BRANCH: 'main' # 你的分支名称
    
  4. 提交和推送更改
    将上述更改提交到你的 GitHub 仓库,并推送至 Gitee,触发 GitHub Actions 工作流。

    git add .github/workflows/gitee-pages.yml
    git commit -m "Add Gitee Pages Action"
    git push origin main
    

完成以上步骤后,每次你向 main 分支推送代码时,GitHub Actions 都会自动运行,构建你的静态网站,并将其部署到 Gitee Pages 上。

以上就是 gitee-pages-action 的安装和配置教程,希望对你有所帮助。

登录后查看全文
热门项目推荐