Gitee Pages Action 项目启动与配置教程

1. 项目的目录结构及介绍

Gitee Pages Action 是一个自动部署 Gitee Pages 的 GitHub Action。以下是项目的目录结构及其说明：

• .github/workflows: 存放 GitHub Action 工作流文件的目录。

  • gitee-pages.yml: GitHub Action 工作流配置文件，用于定义自动部署的流程。

• docs: 存放项目文档的目录。

• src: 源代码目录，可能包含项目的核心逻辑。

• tests: 测试代码目录，用于存放项目的单元测试和集成测试代码。

2. 项目的启动文件介绍

Gitee Pages Action 的启动主要依赖于 GitHub Action。以下是启动文件的介绍：

• .github/workflows/gitee-pages.yml: 这是项目的启动文件，也是 GitHub Action 工作流配置文件。它定义了触发自动部署的条件和执行步骤。

name: Gitee Pages

on:
  push:
    branches:
      - main # 当主分支有 push 操作时触发
  pull_request:
    branches:
      - main # 当主分支有 pull request 时触发

jobs:
  build:
    runs-on: ubuntu-latest # 指定运行环境
    steps:
    - uses: actions/checkout@v2 # 使用 actions/checkout@v2 Action 检出代码
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.x' # 设置 Python 版本
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt # 安装项目依赖
    - name: Build and Deploy
      uses: yanglbme/gitee-pages-action@master # 使用 Gitee Pages Action
      with:
        personalAccessToken: ${{ secrets.GITEE-pages-token }} # Gitee 个人访问令牌
        giteeOwner: '你的Gitee用户名'
        giteeRepo: '你的Gitee仓库名'
        branch: '你的Gitee仓库分支'
        giteePagesDir: '你的Gitee Pages目录'

3. 项目的配置文件介绍

Gitee Pages Action 的配置主要通过修改 .github/workflows/gitee-pages.yml 文件来完成。以下是配置文件的介绍：

• personalAccessToken: 你的 Gitee 个人访问令牌，用于授权 GitHub Action 操作你的 Gitee 仓库。
• giteeOwner: 你的 Gitee 用户名。
• giteeRepo: 你的 Gitee 仓库名。
• branch: 你的 Gitee 仓库中用于部署 Pages 的分支。
• giteePagesDir: 你的 Gitee Pages 目录，通常是仓库中的 docs 目录。

确保在 GitHub 的仓库设置中添加了 GITEE-pages-token 这个 Secret，并将其值设置为你的 Gitee 个人访问令牌。这样，GitHub Action 就能正确地访问你的 Gitee 仓库并部署 Pages。