篩選 Bitbucket Webhook 事件 (主控台)篩選 Bitbucket Webhook 事件 (開發套件) 篩選 Bitbucket Webhook 事件 (AWS CloudFormation)

比特桶網絡鉤事件

您可以使用 Webhook 篩選群組來指定哪些 Bitbucket Webhook 事件會觸發組建。例如，您可以指定只針對特定分支的變更觸發組建。

您可以建立一或多個 Webhook 篩選群組來指定哪些 Webhook 事件會觸發組建。如果任何過濾器組評估為 true，則會觸發構建，當組中的所有過濾器評估為 true 時發生。當您建立篩選群組時，您可以指定這些項目：

一個事件

對於 Bitbucket，您可以選擇下列一或多個事件：

PUSH
PULL_REQUEST_CREATED
PULL_REQUEST_UPDATED
PULL_REQUEST_MERGED
PULL_REQUEST_CLOSED

Webhook 的事件類型位在 X-Event-Key 欄位的標頭中。下表顯示 X-Event-Key 標頭值如何映射到事件類型。

注意

如果您建立會使用 PULL_REQUEST_MERGED 事件類型的 Webhook 篩選群組，則必須在您的 Bitbucket Webhook 設定中啟用 merged 事件。如果您建立使用該declined事件類型的 Webhook 篩選器群組，您也必須在 Bitbucket Webhook 設定中啟用該PULL_REQUEST_CLOSED事件。

`X-Event-Key` 標頭值	事件類型
`repo:push`	`PUSH`
`pullrequest:created`	`PULL_REQUEST_CREATED`
`pullrequest:updated`	`PULL_REQUEST_UPDATED`
`pullrequest:fulfilled`	`PULL_REQUEST_MERGED`
`pullrequest:rejected`	`PULL_REQUEST_CLOSED`

對於PULL_REQUEST_MERGED，如果拉取請求與壓縮策略合併，並且拉取請求分支關閉，則原始提取請求提交將不再存在。在這種情況下，CODEBUILD_WEBHOOK_MERGE_COMMIT環境變量包含壓縮合併提交的標識符。

一個或多個可選的過濾器

使用規則表達式來指定篩選條件。對於觸發構建的事件，與其關聯的組中的每個過濾器都必須評估為 true。

ACTOR_ACCOUNT_ID（ACTOR_ID在控制台中）: 當 Bitbucket 帳戶 ID 與正則表達式模式匹配時，webhook 事件會觸發構建。這個值會出現在 Webhook 篩選條件承載之 actor 物件的 account_id 屬性中。
HEAD_REF: 當頭部引用匹配正則表達式模式（例如，refs/heads/branch-name和refs/tags/tag-name）時，webhook 事件觸發構建。HEAD_REF 篩選條件會評估分支或標籤的 Git 參考名稱。分支或標籤名稱會出現在 Webhook 承載 push 物件之 new 物件的 name 欄位中。針對提取請求事件，分支名稱會出現在 Webhook 承載 source 物件之 branch 物件的 name 欄位中。
BASE_REF: 當基本引用與正則表達式模式匹配時，webhook 事件會觸發構建。BASE_REF 篩選條件僅適用於提取請求事件 (例如 refs/heads/branch-name)。BASE_REF 篩選條件會評估分支的 Git 參考名稱。分支名稱會出現在 Webhook 承載 destination 物件之 branch 物件的 name 欄位中。
FILE_PATH: 當更改文件的路徑與正則表達式模式匹配時，webhook 觸發構建。
COMMIT_MESSAGE: 當頭提交消息與正則表達式模式匹配時，webhook 觸發構建。

注意

您可以在 Bitbucket 儲存庫的 Webhook 設定中找到 Webhook 承載。

主題

篩選 Bitbucket Webhook 事件 (主控台)
篩選 Bitbucket Webhook 事件 (開發套件)
篩選 Bitbucket Webhook 事件 (AWS CloudFormation)

篩選 Bitbucket Webhook 事件 (主控台)

若要使用 AWS Management Console 來篩選網路掛接事件：

當您建立專案時，請選取 Rebuild every time a code change is pushed to this repository (在每次將程式碼變更推送至此儲存庫時重建)。
從 Event type (事件類型)，選擇一或多個事件。
若要篩選事件觸發組建的時間，請在 Start a build under these conditions (在這些情況下開始組建) 下新增一或多個選用的篩選條件。
若要篩選何時不觸發事件，請在 Don't start a build under these conditions (在這些情況下不開始組建) 下新增一或多個選用的篩選條件。
選擇 Add filter group (新增篩選群組) 新增另一個篩選群組。

如需詳細資訊，請參閱建立組建專案 (主控台)和 AWS CodeBuild API 參考中的 WebhookFilter。

在這個範例中，Webhook 篩選群組僅針對提取請求觸發組建：

在有兩個篩選群組的範例中，當一個或兩個篩選群組評估為 true 時，就會觸發組建：

第一個篩選群組指定在分支上建立或更新的提取請求，並且這些分支的 Git 參考名稱符合規則表達式 ^refs/heads/main$，而標頭參考符合 ^refs/heads/branch1!。
第二個篩選群組在分支上指定推送請求，並且這些分支的 Git 參考名稱符合規則表達式 ^refs/heads/branch1$。

在這個範例中，Webhook 篩選群組針對所有請求 (標籤事件除外) 觸發組建。

在這個範例中，只有在檔案名稱符合規則表達式 ^buildspec.* 的檔案變更時，Webhook 篩選群組才會觸發組建。

在此範例中，Webhook 篩選器群組只會在src或test資料夾中變更檔案時觸發組建。

在這個範例中，只有當 Bitbucket 使用者進行變更，而且其帳戶 ID 不符合規則表達式 actor-account-id 時，Webhook 篩選群組才會觸發建置。

注意

有關如何尋找您的 Bitbucket 帳戶 ID 的資訊，請參閱 https://api.bitbucket.org/2.0/users/user-name，其中 user-name 是您的 Bitbucket 使用者名稱。

在此範例中，當 head 提交訊息符合規則運算式 \[CodeBuild\] 時，webhook 篩選群組會觸發推送事件的建置。

篩選 Bitbucket Webhook 事件 (開發套件)

若要使用 AWS CodeBuild SDK 來篩選網路掛接事件，請在CreateWebhook或 UpdateWebhook API 方法的要求語法中使用filterGroups欄位。如需詳細資訊，請參閱 CodeBuild API 參考中的 WebhookFilter。

若要建立 Webhook 篩選條件來只針對提取請求觸發組建，請在請求語法插入以下程式碼：


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

若要建立 Webhook 篩選條件來只針對指定的分支觸發組建，請使用 pattern 參數指定規則表達式來篩選分支名稱。在有兩個篩選群組的範例中，當一個或兩個篩選群組評估為 true 時，就會觸發組建：

第一個篩選群組指定在分支上建立或更新的提取請求，並且這些分支的 Git 參考名稱符合規則表達式 ^refs/heads/main$，而標頭參考符合 ^refs/heads/myBranch$。
第二個篩選群組在分支上指定推送請求，並且這些分支的 Git 參考名稱符合規則表達式 ^refs/heads/myBranch$。


"filterGroups": [
  [
    {
      "type": "EVENT",
      "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED"
    },
    {
      "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_MERGED, PULL_REQUEST_CLOSED"
    },
    {
      "type": "HEAD_REF",
      "pattern": "^refs/tags/.*",
      "excludeMatchedPattern": true
    }
  ]
]

您可以建立篩選條件來指定只有在帳戶 ID 為 actor-account-id 的 Bitbucket 使用者進行變更時，才觸發組建。

注意

有關如何尋找您的 Bitbucket 帳戶 ID 的資訊，請參閱 https://api.bitbucket.org/2.0/users/user-name，其中 user-name 是您的 Bitbucket 使用者名稱。


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

您可以建立篩選條件來指定只有在檔案名稱符合 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/.+"
        }
    ]
]

您可以建立篩選條件，只有在 head 提交訊息符合模式引數中的規則運算式時，才觸發組建。在這個範例中，篩選群組指定只有在推送事件的 head 遞交訊息符合規則表達式 \[CodeBuild\] 時，才觸發組建。


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

篩選 Bitbucket Webhook 事件 (AWS CloudFormation)

若要使用 AWS CloudFormation 範本來篩選 webhook 事件，請使用 AWS CodeBuild 專案的FilterGroups屬性。在 AWS CloudFormation 範本中，以下 YAML 格式的部分建立兩個篩選群組。當其中一個或兩個評估為 true 時，它們會一起觸發組建：

第一個篩選群組指定在分支上建立或更新的提取請求，並且這些分支的 Git 參考名稱符合規則表達式 ^refs/heads/main$，而且是由帳戶 ID 不是 12345 的 Bitbucket 使用者所建立或更新。
第二個篩選群組指定分支上建立的推送請求，並且這些分支的 Git 參考名稱符合規則表達式 ^refs/heads/.*。
第三個篩選群組會指定其 head 提交訊息符合規則運算式 \[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: BITBUCKET
      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/.+

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

網鉤

GitHub 網絡掛鉤事件