GitHub Actions：快速部署PR预览到GitHub Pages教程

GitHub Actions：快速部署PR预览到GitHub Pages教程

pr-preview-actionGitHub Action that deploys a pull request preview to GitHub Pages, similar to Vercel and Netlify, and cleans up after itself.项目地址:https://gitcode.com/gh_mirrors/pr/pr-preview-action

本教程将引导您了解并使用rossjrw/pr-preview-action，一个能够自动为您的GitHub仓库中的拉取请求（Pull Requests）创建并部署预览页面至GitHub Pages的神器。我们将深入探讨其核心组件，包括目录结构、启动与配置要素。

1. 项目目录结构及介绍

虽然具体的项目结构可能随项目自身需求定制而异，但rossjrw/pr-preview-action作为一个GitHub Action，并不直接定义一个常规的应用程序目录结构。它是由一系列YAML配置文件驱动的工作流程构成。然而，当在您的仓库中应用此Action时，重要的是理解以下几个关键点：

• .github/workflows: 这是放置GitHub Actions工作流配置文件的地方。比如，您可能会有一个名为deploy-pr-preview.yml的文件来设置如何触发并执行这个Action。
• source-dir: 指定的源代码目录路径，这是您的构建内容所在处，将会被部署到Pages上。通常，在配置Action时通过参数指定。

2. 项目的启动文件介绍

对于此特定的GitHub Action，没有传统的“启动文件”。它的“启动”过程是由GitHub事件触发的，如Pull Request的打开、重新打开或同步等。关键在于配置文件（通常是.github/workflows/deploy-pr-preview.yml或其他自定义命名的工作流文件），示例如下：

name: Deploy PR Preview
on:
  pull_request:
    types: [opened, synchronize]
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: npm install && npm run build # 假设项目基于npm
      - uses: rossjrw/pr-preview-action@v1
        with:
          source-dir: ./build

这里的YAML文件就是启动Action的“指令集”。

3. 项目的配置文件介绍

配置主要通过在工作流文件中利用GitHub Action的参数进行。以rossjrw/pr-preview-action为例，配置通常涉及几个关键参数：

• source-dir: 需要部署的预览版本的构建输出目录。
• action: 可以是deploy(部署)或remove(移除)，控制是否部署新的预览或当PR关闭时清理旧预览。
• 条件判断 (if): 可以用来更精细地控制Action的行为，例如仅在特定事件（如opened, synchronized, 或 closed且未合并的情况下）触发操作。

- uses: rossjrw/pr-preview-action@v1
  with:
    source-dir: /path/to/your/build/folder
    action: 'deploy' # 或 'remove'
    if: ${{ github.event.action == 'closed' && github.event.pull_request.merged }}

总结来说，虽然该Action本身不直接管理一个可下载或直接编辑的代码结构，但它在GitHub仓库的.github/workflows目录下的配置文件是其运行的核心，这些配置决定了何时、何地以及如何部署Pull Request的预览环境。通过灵活运用这些配置，您可以轻松实现高效的代码审查与迭代流程。

pr-preview-actionGitHub Action that deploys a pull request preview to GitHub Pages, similar to Vercel and Netlify, and cleans up after itself.项目地址:https://gitcode.com/gh_mirrors/pr/pr-preview-action