Webhook フィルタグループを使用して、ビルドをトリガーする GitHub ウェブフックイベントを指定できます。たとえば、特定のブランチへの変更に対してのみビルドをトリガーするように指定できます。
ビルドをトリガーするウェブフックイベントを指定するには、ウェブフックフィルタグループを 1 つ以上作成できます。任意のフィルターグループが true と評価されると、ビルドがトリガーされます。これは、グループ内のすべてのフィルターが true と評価されたときに発生します。フィルタグループを作成する際、以下を指定します。
- イベント
-
GitHub では、次のイベントのうち、1 つ以上を選択できます:
PUSH
、PULL_REQUEST_CREATED
、PULL_REQUEST_UPDATED
、PULL_REQUEST_REOPENED
、PULL_REQUEST_MERGED
、PULL_REQUEST_CLOSED
、RELEASED
、PRERELEASED
、WORKFLOW_JOB_QUEUED
。ウェブフックのイベントタイプは、ウェブフックペイロードのX-GitHub-Event
ヘッダーに含まれています。X-GitHub-Event
ヘッダーで、pull_request
またはpush
が表示される場合があります。プルリクエストイベントの場合、このタイプはウェブフックイベントペイロードのaction
フィールドに含まれています。以下の表に示すのは、X-GitHub-Event
ヘッダー値とウェブフックのプルリクエストペイロードのaction
フィールドが、利用可能なイベントタイプにマッピングされる方法を示しています。X-GitHub-Event
ヘッダー値ウェブフックイベントペイロードの action
値イベントタイプ pull_request
opened
PULL_REQUEST_CREATED
pull_request
reopened
PULL_REQUEST_REOPENED
pull_request
synchronize
PULL_REQUEST_UPDATED
pull_request
closed
、およびmerged
フィールドはtrue
PULL_REQUEST_MERGED
pull_request
closed
、およびmerged
フィールドはfalse
PULL_REQUEST_CLOSED
push
該当なし PUSH
release
released RELEASED
release
prereleased PRERELEASED
workflow_job
queued WORKFLOW_JOB_QUEUED
注記
PULL_REQUEST_REOPENED
イベントタイプは GitHub および GitHub Enterprise Server でのみ使用できます。RELEASED
、PRERELEASED
、WORKFLOW_JOB_QUEUED
イベントタイプは、GitHub のみで使用できます。WORKFLOW_JOB_QUEUED
の詳細については、「チュートリアル: CodeBuild がホストする GitHub Actions ランナーを設定」をご参照ください。 - 1 つ以上のオプションフィルタ
-
フィルタを指定するには、正規表現を使用します。ビルドをトリガーするイベントでは、関連付けられているグループ内のすべてのフィルターが true と評価される必要があります。
ACTOR_ACCOUNT_ID
(コンソール内のACTOR_ID
)-
GitHub、GitHub Enterprise サーバーのアカウント ID が正規表現 パターンと一致すると、Webhook イベントによってビルドがトリガーされます。この値は、ウェブフックペイロードの
sender
オブジェクトのid
プロパティで見つかります。 HEAD_REF
-
ヘッドリファレンスが正規表現パターンと一致すると、ウェブフックイベントによりビルドがトリガーされます (例:
refs/heads/branch-name
またはrefs/tags/tag-name
)。プッシュイベントの場合、参照名はウェブフックペイロードのref
プロパティで見つかります。プルリクエストイベントの場合、ブランチ名はウェブフックペイロードのhead
オブジェクトのref
プロパティで見つかります。 BASE_REF
-
基本参照が正規表現パターンと一致するとウェブフックイベントによってビルドがトリガーされます。(例
refs/heads/branch-name
)BASE_REF
フィルタは、プルリクエストイベントでのみ使用できます。ブランチ名は、ウェブフックペイロードでbase
オブジェクトのref
プロパティで見つかります。 FILE_PATH
-
変更されたファイルのパスが正規表現パターンと一致すると、ビルドがウェブフックイベントでトリガーされます。
FILE_PATH
フィルタは、GitHub のプッシュおよびプルリクエストイベントと GitHub Enterprise Server のプッシュイベントで使用できます。GitHub Enterprise Server のプルリクエストイベントでは使用できません。 COMMIT_MESSAGE
-
HEAD コミットメッセージが正規表現パターンに一致する場合に、Webhook はビルドをトリガーします。
COMMIT_MESSAGE
フィルタは、GitHub のプッシュおよびプルリクエストイベントと GitHub Enterprise Server のプッシュイベントで使用できます。GitHub Enterprise Server のプルリクエストイベントでは使用できません。 TAG_NAME
-
リリースのタグ名が正規表現パターンに一致すると、ウェブフックはビルドをトリガーします。
TAG_NAME
フィルタは、GitHub リリースおよびプレリリースされたリクエストイベントで使用できます。 RELEASE_NAME
-
リリース名が正規表現パターンに一致すると、ウェブフックはビルドをトリガーします。
RELEASE_NAME
フィルタは、GitHub リリースおよびプレリリースされたリクエストイベントで使用できます。 REPOSITORY_NAME
-
リポジトリ名が正規表現パターンに一致すると、ウェブフックはビルドをトリガーします。
REPOSITORY_NAME
フィルタは、GitHub グローバルまたは組織のウェブフックでのみ使用できます。 WORKFLOW_NAME
-
ワークフロー名が正規表現パターンに一致する場合に、ウェブフックはビルドをトリガーします。
WORKFLOW_NAME
フィルタは、GitHub Actions ワークフロージョブのキューに入れられたリクエストイベントで使用できます。
注記
ウェブフックペイロードは、GitHub リポジトリのウェブフック設定で見つかります。