GitHub Actions 部署到 GitHub Pages 教程

1. 项目介绍

deploy-pages 是一个 GitHub Action，用于将之前上传为工件（artifact）的 Pages 站点部署到 GitHub Pages。这个 Action 推荐在专门的作业中使用，以确保部署过程的独立性和可靠性。

主要功能

• 部署工件：将之前上传的工件部署到 GitHub Pages。
• 环境支持：支持 github-pages 环境，并可根据需要配置不同的环境。
• 权限控制：通过 GITHUB_TOKEN 进行权限控制，确保部署的安全性。

2. 项目快速启动

2.1 创建工作流文件

在你的 GitHub 仓库中，创建一个 .github/workflows/deploy.yml 文件，并添加以下内容：

name: Deploy to GitHub Pages

on:
  push:
    branches:
      - main

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

      - name: Upload Pages Artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./build

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: $[[ steps.deployment.outputs.page_url ]]
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
        with:
          token: $[[ secrets.GITHUB_TOKEN ]]

2.2 配置权限

确保你的 GITHUB_TOKEN 具有足够的权限来部署到 GitHub Pages。你可以在仓库的设置中配置这些权限。

2.3 触发部署

将上述工作流文件推送到 main 分支，GitHub Actions 将自动触发部署过程。

3. 应用案例和最佳实践

3.1 静态网站部署

使用 deploy-pages 可以轻松地将静态网站部署到 GitHub Pages。例如，你可以使用 React、Vue 或 Hugo 等框架生成静态网站，然后通过 upload-pages-artifact 上传生成的工件，最后使用 deploy-pages 进行部署。

3.2 CI/CD 集成

将 deploy-pages 集成到你的 CI/CD 流程中，可以在每次代码推送时自动部署到 GitHub Pages，确保网站内容的实时更新。

3.3 多环境部署

通过配置不同的环境，你可以在不同的分支或环境中进行部署。例如，你可以在 staging 环境中测试部署，然后在 production 环境中正式发布。

4. 典型生态项目

4.1 actions/upload-pages-artifact

upload-pages-artifact 是 deploy-pages 的配套 Action，用于将生成的工件上传到 GitHub Pages。它支持多种文件格式和路径，确保你可以灵活地上传所需的文件。

4.2 actions/checkout

checkout 是一个常用的 GitHub Action，用于从仓库中检出代码。在部署过程中，通常需要先检出代码，然后再进行构建和部署。

4.3 actions/setup-node

如果你使用 Node.js 进行开发，setup-node 可以帮助你快速设置 Node.js 环境，并安装所需的依赖包。这对于构建静态网站非常有用。

通过以上模块的介绍，你可以快速上手并使用 deploy-pages 进行 GitHub Pages 的部署。希望这篇教程对你有所帮助！