翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# GitHub ウェブフックイベント
<a name="github-webhook"></a>

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` フィールドが、利用可能なイベントタイプにマッピングされる方法を示しています。      
[See the AWS documentation website for more details](http://docs.aws.amazon.com/ja_jp/codebuild/latest/userguide/github-webhook.html)
 `PULL_REQUEST_REOPENED` イベントタイプは GitHub および GitHub Enterprise Server でのみ使用できます。`RELEASED` および `PRERELEASED` イベントタイプは、GitHub のみで使用できます。`WORKFLOW_JOB_QUEUED` の詳細については、「[チュートリアル: CodeBuild がホストする GitHub Actions ランナーを設定](action-runner.md)」をご参照ください。

**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 グローバルまたは組織のウェブフックでのみ使用できます。  
`ORGANIZATION_NAME`  
組織名が正規表現パターンに一致する場合に、ウェブフックはビルドをトリガーします。`ORGANIZATION_NAME` フィルタは、GitHub グローバルウェブフックでのみ使用できます。  
`WORKFLOW_NAME`  
ワークフロー名が正規表現パターンに一致する場合に、ウェブフックはビルドをトリガーします。`WORKFLOW_NAME` フィルタは、GitHub Actions ワークフロージョブのキューに入れられたリクエストイベントで使用できます。

**注記**  
ウェブフックペイロードは、GitHub リポジトリのウェブフック設定で見つかります。

**Topics**
+ [GitHub ウェブフックイベントのフィルタリング (コンソール)](github-webhook-events-console.md)
+ [GitHub ウェブフックイベントのフィルタリング (SDK)](github-webhook-events-sdk.md)
+ [GitHub ウェブフックイベントのフィルタリング (CloudFormation)](github-webhook-events-cfn.md)