使用 peaceiris/actions-gh-pages 部署 GitHub Pages

项目介绍

peaceiris/actions-gh-pages 是一个 GitHub Actions 工作流，用于自动化部署静态网站到 GitHub Pages。这个项目支持多种静态网站生成器，如 Jekyll、Hugo、Hexo 等，并且可以轻松配置以适应不同的部署需求。

项目快速启动

步骤 1: 创建 GitHub Actions 工作流文件

在你的 GitHub 仓库中，创建一个 .github/workflows 目录（如果还没有的话），然后在该目录下创建一个名为 deploy-gh-pages.yml 的文件。

步骤 2: 配置工作流文件

将以下内容复制到 deploy-gh-pages.yml 文件中：

name: Deploy to GitHub Pages

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Setup Node
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Install dependencies
        run: npm install

      - name: Build
        run: npm run build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./dist

步骤 3: 提交并推送

将修改后的文件提交并推送到 GitHub 仓库的 main 分支。GitHub Actions 将自动运行并部署你的静态网站到 GitHub Pages。

应用案例和最佳实践

应用案例

• 个人博客: 使用 Hugo 或 Jekyll 生成静态博客，并通过 peaceiris/actions-gh-pages 自动部署到 GitHub Pages。
• 项目文档: 使用 Docusaurus 或 VuePress 生成项目文档网站，并自动化部署。

最佳实践

• 使用环境变量: 在 GitHub Actions 中使用环境变量来存储敏感信息，如 API 密钥等。
• 缓存依赖: 使用 actions/cache 来缓存 Node.js 依赖，加快构建速度。
• 多分支部署: 配置多个工作流文件，分别处理不同分支的部署需求。

典型生态项目

• actions/checkout: 用于检出仓库代码。
• actions/setup-node: 用于设置 Node.js 环境。
• actions/cache: 用于缓存依赖，加快构建速度。

通过结合这些生态项目，可以构建一个高效、自动化的 GitHub Pages 部署流程。