AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

GitHub Webhook 事件

您可以使用 Webhook 筛选条件组指定哪些 GitHub Webhook 事件触发构建。例如，您可以指定仅为指定的分支触发构建。

您可以创建一个或多个 Webhook 筛选条件组，以指定哪些 Webhook 事件触发构建。如果一个或多个筛选条件组上的所有筛选条件都评估为 True，则会触发构建。创建筛选条件组时，应指定：

筛选 GitHub Webhook 事件(控制台)

在 Primary source webhook events (主要源 Webhook 事件) 中,选择以下内容。仅当您为源存储库选择 Repository in my GitHub account (我的 AWS 账户中的存储库) 时,此部分才可用。

有关更多信息,请参阅 创建构建项目 (控制台)API 参考 中的 WebhookFilter 和 AWS CodeBuild。

在此示例中，Webhook 筛选条件组仅针对拉取请求触发构建：

以两个 Webhook 筛选条件组为例，当一个或两个筛选条件评估为 True 时触发构建：

在此示例中，Webhook 筛选条件组会针对除标记事件之外的所有请求触发构建。

在此示例中，仅当名称与正则表达式 ^buildspec.* 匹配的文件发生更改时，Webhook 筛选条件组才会触发构建。

在此示例中,只有当其账户 ID 与正则表达式 GitHub 匹配的指定 GitHub 或 actor-account-id Enterprise Server 用户进行更改时,Webhook 筛选条件组才会触发构建。

在本示例中，当 HEAD 提交消息与正则表达式 \[CodeBuild\] 匹配时，Webhook 筛选条件组会触发推送事件的构建。

筛选 GitHub Webhook 事件(开发工具包)

要使用 AWS CodeBuild 开发工具包筛选 Webhook 事件，请使用 CreateWebhook 或 UpdateWebhook API 方法的请求语法中的 filterGroups 字段。有关更多信息，请参阅 CodeBuild API 参考 中的 WebhookFilter。

要创建仅针对拉取请求触发构建的 Webhook 筛选条件，请在请求语法中插入以下内容：

"filterGroups": [
   [
        {
            "type": "EVENT", 
            "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED"
        }
    ]
]

要创建仅针对指定分支触发构建的 Webhook 筛选条件，请使用 pattern 参数指定用于过滤分支名称的正则表达式。以两个筛选条件组为例，当一个或两个筛选条件评估为 True 时触发构建：

"filterGroups": [
    [
        {
            "type": "EVENT", 
            "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED"
        },
        {
            "type": "HEAD_REF", 
            "pattern": "^refs/heads/myBranch$"
        },
        {
            "type": "BASE_REF", 
            "pattern": "^refs/heads/main$"
        }
    ],
    [
        {
            "type": "EVENT", 
            "pattern": "PUSH"
        },
        {
            "type": "HEAD_REF", 
            "pattern": "^refs/heads/myBranch$"
        }
    ]
]

您可以使用 excludeMatchedPattern 参数指定不触发构建的事件。例如，在此示例中，将针对除标记事件之外的所有请求触发构建。

"filterGroups": [
    [
        {
            "type": "EVENT", 
            "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED"
        },
        {
            "type": "HEAD_REF", 
            "pattern": "^refs/tags/.*", 
            "excludeMatchedPattern": true
        }
    ]
]

您可以创建只有当名称与 pattern 参数中的正则表达式匹配的文件发生更改时，才触发构建的筛选条件。在此示例中，筛选条件组指定仅当名称与正则表达式 ^buildspec.* 匹配的文件更改时才触发构建。

"filterGroups": [
    [
        {
            "type": "EVENT", 
            "pattern": "PUSH"
        },
        {
            "type": "FILE_PATH", 
            "pattern": "^buildspec.*"
        }
    ]
]

您可以创建仅当账户 ID 为 GitHub 的指定 GitHub 或 actor-account-id Enterprise Server 用户进行更改时,才触发构建的筛选条件。

"filterGroups": [
    [
        {
            "type": "EVENT", 
            "pattern": "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED"
        },
        {
            "type": "ACTOR_ACCOUNT_ID", 
            "pattern": "actor-account-id"
        }
    ]
]

您可以创建一个筛选条件，仅当 HEAD 提交消息与模式参数中的正则表达式匹配时才触发构建操作。在本示例中，筛选条件组指定仅当推送事件的 HEAD 提交消息与正则表达式 \[CodeBuild\] 匹配时，才触发构建操作。

"filterGroups": [
    [
        {
            "type": "EVENT",
            "pattern": "PUSH"
        },
        {
            "type": "COMMIT_MESSAGE",
            "pattern": "\[CodeBuild\]"
        }
    ]
]

筛选 GitHub Webhook 事件 (AWS CloudFormation)

要使用 AWS CloudFormation 模板来筛选 Webhook 事件，请使用 AWS CodeBuild 项目的 FilterGroups 属性。AWS CloudFormation 模板的以下 YAML 格式的部分创建两个筛选条件组。当这两个筛选条件的其中一个或两个评估为 True 时触发构建：

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:4.0
    Source:
      Type: GITHUB
      Location: source-location
    Triggers:
      Webhook: true
      FilterGroups:
        - - Type: EVENT
            Pattern: PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED
          - Type: BASE_REF
            Pattern: ^refs/heads/main$
            ExcludeMatchedPattern: false
          - Type: ACTOR_ACCOUNT_ID
            Pattern: 12345
            ExcludeMatchedPattern: true
        - - Type: EVENT
            Pattern: PUSH
          - Type: HEAD_REF
            Pattern: ^refs/heads/.*
          - Type: FILE_PATH
            Pattern: READ_ME
            ExcludeMatchedPattern: true
        - - Type: EVENT
            Pattern: PUSH
          - Type: COMMIT_MESSAGE
          - Pattern: \[CodeBuild\]