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

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

GitHub webhook 事件

您可以使用 webhook 筛选器组来指定哪些 GitHub Webhook 事件会触发构建。例如，您可以指定仅在对特定分支做出更改时触发构建。

您可以创建一个或多个 Webhook 筛选条件组，来指定哪些 Webhook 事件触发构建。如果任何筛选条件组评估为 true（即组中的所有筛选条件都评估为 true），则会触发构建。创建筛选条件组时，应指定：

筛选 GitHub webhook 事件（控制台）

在主要源 webhook 事件中，选择以下内容。只有当您在我的 GitHub账户中为源存储库选择存储库时，此部分才可用。

有关更多信息，请参阅 “Amazon CodeBuild API参考” WebhookFilter中的 “创建构建项目（控制台）和”。

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

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

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

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

在此示例中，仅当 src 或 test 文件夹中的文件发生更改时，Webhook 筛选条件组才会触发构建。

在此示例中，只有当帐户 ID 与正则表达式actor-account-id匹配的指定用户 GitHub 或 GitHub 企业服务器用户进行更改时，Webhook 筛选器组才会触发构建。

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

在此示例中，webhook 筛选器组仅触发 Actions 工作 GitHub 流程作业事件的构建。

在此示例中，webhook 筛选器组会触发与正则表达式CI-CodeBuild匹配的工作流程名称的构建。

筛选 GitHub webhook 事件 () SDK

要使用过滤 webhook 事件，请使用CreateWebhook或UpdateWebhookAPI方法的请求语法中的filterGroups字段。 Amazon CodeBuild SDK有关更多信息，请参阅 “CodeBuild API参考” WebhookFilter中的。

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

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

要创建仅针对指定分支触发构建的 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, PULL_REQUEST_CLOSED"
        },
        {
            "type": "HEAD_REF", 
            "pattern": "^refs/tags/.*", 
            "excludeMatchedPattern": true
        }
    ]
]

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

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

在此示例中，筛选条件组指定仅当 src 或 test 文件夹中的文件发生更改时，才会触发构建。

"filterGroups": [
    [
        {
            "type": "EVENT", 
            "pattern": "PUSH"
        },
        {
            "type": "FILE_PATH", 
            "pattern": "^src/.+|^test/.+"
        }
    ]
]

您可以创建仅当具有帐户 ID 的指定用户 GitHub 或 E GitHub nterprise Server 用户进行更改时才会触发构建的筛选器actor-account-id。

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

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

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

要创建仅触发 Actions 工作流程任务生成的 GitHub webhook 过滤器，请在请求语法中插入以下内容：

"filterGroups": [
   [
        {
            "type": "EVENT", 
            "pattern": "WORKFLOW_JOB_QUEUED"
        }
    ]
]

筛选 GitHub webhook 事件 ()Amazon CloudFormation

要使用 Amazon CloudFormation 模板过滤 webhook 事件，请使用 Amazon CodeBuild 项目的FilterGroups属性。 Amazon 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:5.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\]
          - Type: FILE_PATH
            Pattern: ^src/.+|^test/.+
        - - Type: EVENT
            Pattern: WORKFLOW_JOB_QUEUED
          - Type: WORKFLOW_NAME
            Pattern: \[CI-CodeBuild\]