使用 GitHub Actions 进行部署

注意：GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。可以在 GitHub public roadmap 上查看有关未来支持计划的更多信息。

简介

GitHub Actions 提供了允许您控制部署的功能。方法：

使用各种事件触发工作流程。
配置环境以在作业可以继续之前设置规则，并限制对机密的访问。
使用并发性来控制一次运行的部署数。

有关持续部署的详细信息，请参阅“关于使用 GitHub Actions 进行持续部署”。

先决条件

您应该熟悉 GitHub Actions 的语法。有关详细信息，请参阅“写入工作流”。

触发部署

您可以使用各种事件来触发您的部署工作流程。一些最常见的事件包括：pull_request、push 和 workflow_dispatch。

例如，具有以下触发器的工作流在以下情况下会运行：

存在针对 main 分支的推送。
以 main 分支为目标的拉取请求已打开、已同步或重新打开。
有人手动触发它。

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  workflow_dispatch:

有关详细信息，请参阅“触发工作流的事件”。

使用环境

环境用于描述常规部署目标，例如 production、staging 或 development。当 GitHub Actions 工作流部署到某个环境时，该环境将显示在存储库的主页上。可以使用环境来要求批准作业才能继续，限制哪些分支可以触发工作流，使用自定义部署保护规则控制部署，或限制对机密的访问。有关创建环境的详细信息，请参阅“管理部署环境”。

使用并发

并发确保只有使用相同并发组的单一作业或工作流程才会同时运行。您可以使用并发，以便环境中每次最多有一个正在进行的部署和一个待处理的部署。有关并发的详细信息，请参阅“控制工作流和作业的并发性”。

Note

concurrency 和 environment 未连接。并发值可以是任何字符串；它无需是环境名称。此外，如果另一个工作流程使用相同的环境，但未指定并发性，则该工作流程将不受任何并发规则的约束。

例如，当以下工作流运行时，如果使用 production 并发组的任何作业或工作流正在进行中，则它将暂停并且状态为 pending。它还将取消使用 production 并发组且状态为 pending 的任何作业或工作流。这意味着，由于使用了 production 并发组，因此最多有一个正在运行和一个待处理的作业或工作流。

name: Deployment

concurrency: production

on:
  push:
    branches:
      - main

jobs:
  deployment:
    runs-on: ubuntu-latest
    environment: production
    steps:
      - name: deploy
        # ...deployment-specific steps

您也可以在作业级别指定并发性。这将允许工作流中的其他作业继续，即使并发作业的状态为 pending。

name: Deployment

on:
  push:
    branches:
      - main

jobs:
  deployment:
    runs-on: ubuntu-latest
    environment: production
    concurrency: production
    steps:
      - name: deploy
        # ...deployment-specific steps

还可以使用 cancel-in-progress 取消同一并发组中任何当前正在运行的作业或工作流。

name: Deployment

concurrency:
  group: production
  cancel-in-progress: true

on:
  push:
    branches:
      - main

jobs:
  deployment:
    runs-on: ubuntu-latest
    environment: production
    steps:
      - name: deploy
        # ...deployment-specific steps

有关如何编写特定于部署的步骤的指导，请参阅“查找部署示例”。

许多服务提供商还提供针对 GitHub Marketplace 的操作，用于部署到他们的服务。有关完整列表，请参阅 GitHub Marketplace。

使用 GitHub Actions 进行部署

本文内容

简介

先决条件

触发部署

使用环境

使用并发

查看部署历史记录

监控工作流程运行

通过应用跟踪部署

选择运行器

显示状态徽章

查找部署示例