教程：配置 CodeBuild 托管的 GitHub Actions 运行器

本教程演示了如何配置 CodeBuild 项目来运行 GitHub Actions 作业。有关将 GitHub Actions 与 CodeBuild 结合使用的更多信息，请参阅教程：配置 CodeBuild 托管的 GitHub Actions 运行器。

要完成本教程，您首先必须：

步骤 1：创建带有 webhook 的 CodeBuild 项目

在此步骤中，您将创建一个带有 webhook 的 CodeBuild 项目，并在 GitHub 控制台中进行检查。您也可以选择 GitHub Enterprise 作为源提供商。要了解有关在 GitHub Enterprise 中创建 webhook 的更多信息，请参阅GitHub 手动 webhook。

步骤 2：更新 GitHub Actions 工作流 YAML

在此步骤中，您将在 GitHub 中更新 GitHub Actions 工作流 YAML 文件，以便配置您的构建环境并在 CodeBuild 中使用 GitHub Actions 自托管运行器。有关更多信息，请参阅在自托管运行器中使用标签和CodeBuild 托管的 GitHub Actions 运行器支持的标签覆盖。

更新 GitHub Actions 工作流 YAML

导航至 GitHub 并更新 GitHub Actions 工作流 YAML 中的 runs-on 设置，以便配置您的构建环境。为此，您可以执行以下操作之一：

在 INSTALL、PRE_BUILD 和 POST_BUILD 阶段运行 buildspec 命令

默认情况下，在运行自托管 GitHub Actions 构建时，CodeBuild 会忽略任何 buildspec 命令。要在构建期间运行 buildspec 命令，可以将 buildspec-override:true 作为后缀添加到标签中：

runs-on:
  - codebuild-<project-name>-${{ github.run_id }}-${{ github.run_attempt }}
    buildspec-override:true

通过使用此命令，CodeBuild 将在容器的主源文件夹中创建一个名为 actions-runner 的文件夹。当 GitHub Actions 运行器在 BUILD 阶段启动时，运行器将在 actions-runner 目录中运行。

在自托管 GitHub Actions 构建中使用 buildspec 覆盖有几个限制：

步骤 3：检查您的结果

每当 GitHub Actions 工作流运行时，CodeBuild 都会通过 webhook 接收工作流作业事件。对于工作流中的每项作业，CodeBuild 都会启动一个构建来运行临时的 GitHub Actions 运行器。该运行器负责执行单个工作流作业。作业完成后，运行器和关联的构建过程会立即终止。

要查看工作流作业日志，请在 GitHub 中导航到您的存储库，选择操作，选择所需的工作流，然后选择要查看日志的特定作业。

在 CodeBuild 中等待自托管运行器提取作业时，您可以在日志中查看请求的标签。

作业完成后，您将能够查看该作业的日志。

GitHub Actions 运行程序配置选项

您可以在项目配置中指定以下环境变量，以修改自托管运行程序的设置配置。

筛选 GitHub Actions webhook 事件（CloudFormation）

CloudFormation 模板的以下 YAML 格式部分创建一个筛选条件组，该组在计算结果为 true 时会触发构建。以下筛选条件组指定 GitHub Actions 工作流作业请求，其工作流名称与正则表达式 \[CI-CodeBuild\] 匹配。

CodeBuildProject:
  Type: AWS::CodeBuild::Project
  Properties:
    Name: MyProject
    ServiceRole: service-role
    Artifacts:
      Type: NO_ARTIFACTS
    Environment:
      Type: LINUX_CONTAINER
      ComputeType: BUILD_GENERAL1_SMALL
      Image: aws/codebuild/standard:5.0
    Source:
      Type: GITHUB
      Location: CODEBUILD_DEFAULT_WEBHOOK_SOURCE_LOCATION
    Triggers:
      Webhook: true
      ScopeConfiguration:
        Name: organization-name
        Scope: GITHUB_ORGANIZATION
      FilterGroups:
        - - Type: EVENT
            Pattern: WORKFLOW_JOB_QUEUED
          - Type: WORKFLOW_NAME
            Pattern: \[CI-CodeBuild\]

筛选 GitHub Actions webhook 事件（AWS CDK）

以下 AWS CDK 模板创建一个筛选条件组，该组在计算结果为 true 时会触发构建。以下筛选条件组指定 GitHub Actions 工作流作业请求。

import { aws_codebuild as codebuild } from 'aws-cdk-lib';
import {EventAction, FilterGroup} from "aws-cdk-lib/aws-codebuild";

const source = codebuild.Source.gitHub({
      owner: 'owner',
      repo: 'repo',
      webhook: true,
      webhookFilters: [FilterGroup.inEventOf(EventAction.WORKFLOW_JOB_QUEUED)],
    })

筛选 GitHub Actions webhook 事件（Terraform）

以下 Terraform 模板创建一个筛选条件组，该组在计算结果为 true 时会触发构建。以下筛选条件组指定 GitHub Actions 工作流作业请求。

resource "aws_codebuild_webhook" "example" {
  project_name = aws_codebuild_project.example.name
  build_type   = "BUILD"
  filter_group {
    filter {
      type    = "EVENT"
      pattern = "WORKFLOW_JOB_QUEUED"
    }
  }
}

筛选 GitHub Actions webhook 事件（AWS CLI）

以下 AWS CLI 命令创建一个自托管 GitHub Actions 运行程序项目，并具有一个 GitHub Actions 工作流程作业请求筛选条件组，该筛选条件组在计算结果为 true 时触发构建。

aws codebuild create-project \
--name <project name> \
--source "{\"type\":\"GITHUB\",\"location\":\"<repository location>\",\"buildspec\":\"\"}" \
--artifacts {"\"type\":\"NO_ARTIFACTS\""} \
--environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/amazonlinux-x86_64-standard:5.0\",\"computeType\": \"BUILD_GENERAL1_MEDIUM\"}" \
--service-role "<service role ARN>"

aws codebuild create-webhook \
--project-name <project name> \
--filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"WORKFLOW_JOB_QUEUED\"}]]"