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

AWS::CodeBuild::Project WebhookFilter

WebhookFilterAWS CodeBuild Project ProjectTriggers 属性类型中 FilterGroups 属性的结构,用于指定触发 AWS CodeBuild 构建 Webhook。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "ExcludeMatchedPattern" : Boolean, "Pattern" : String, "Type" : String }

YAML

ExcludeMatchedPattern: Boolean Pattern: String Type: String

属性

ExcludeMatchedPattern

用于指示 pattern 确定哪些 Webhook 事件不会触发构建。如果为 true,则与 pattern 不匹配的 Webhook 事件将触发构建。如果为 false,则与 pattern 匹配的 Webhook 事件将触发构建。

必需:否

类型:布尔值

Update requires: No interruption

Pattern

对于使用 EVENT 类型的 WebHookFilter,为一个指定一个或多个事件的逗号分隔的字符串。例如,Webhook 筛选器 PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED 允许所有推送事件、已创建拉取请求事件和已更新拉取请求事件触发构建。

对于使用任何其他筛选器类型的 WebHookFilter,为正则表达式模式。例如,当标头引用是具有参考名 refs/heads/branch-name 的分支时,使用 HEAD_REF 作为其 type 并使用模式 ^refs/heads/WebHookFilter 将触发构建。

必需:是

类型:字符串

Update requires: No interruption

Type

Webhook 筛选器的类型。有六种 Webhook 筛选器类型:EVENTACTOR_ACCOUNT_IDHEAD_REFBASE_REFFILE_PATHCOMMIT_MESSAGE

EVENT

当提供的 pattern 与下列五个事件类型之一匹配时,Webhook 事件会触发构建:PUSHPULL_REQUEST_CREATEDPULL_REQUEST_UPDATEDPULL_REQUEST_REOPENEDPULL_REQUEST_MERGED。将 EVENT 模式指定为逗号分隔的字符串。例如,PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED 筛选所有推送事件、已创建拉取请求事件和已更新拉取请求事件。

注意

PULL_REQUEST_REOPENED 仅适用于 GitHub 和 GitHub Enterprise。

ACTOR_ACCOUNT_ID

当 GitHub、GitHub Enterprise 或 Bitbucket 账户 ID 与正则表达式 pattern 匹配时,Webhook 事件会触发构建。

HEAD_REF

当标头引用与正则表达式 pattern 匹配时,Webhook 事件会触发构建。例如,refs/heads/branch-namerefs/tags/tag-name

适用于 GitHub 和 GitHub Enterprise 推送、GitHub 和 GitHub Enterprise 拉取请求、Bitbucket 推送以及 Bitbucket 拉取请求事件。

BASE_REF

当基础引用与正则表达式 pattern 匹配时,Webhook 事件会触发构建。例如:refs/heads/branch-name

注意

仅适用于拉取请求事件。

FILE_PATH

当更改的文件的路径与正则表达式 pattern 匹配时,Webhook 会触发构建。

注意

适用于 GitHub 和 Bitbucket 事件推送和拉取请求事件。也适用于 GitHub Enterprise 推送事件,但不适用于 GitHub Enterprise 拉取请求事件。

COMMIT_MESSAGE

当标头提交消息与正则表达式 pattern 匹配时,Webhook 触发构建。

注意

适用于 GitHub 和 Bitbucket 事件推送和拉取请求事件。也适用于 GitHub Enterprise 推送事件,但不适用于 GitHub Enterprise 拉取请求事件。

必需:是

类型:字符串

允许的值ACTOR_ACCOUNT_ID | BASE_REF | COMMIT_MESSAGE | EVENT | FILE_PATH | HEAD_REF

Update requires: No interruption