グローバルまたは組織の GitHub ウェブフックを設定するための大まかなステップは次のとおりです。グローバルおよび組織の GitHub ウェブフックの詳細については、「GitHub グローバルおよび組織のウェブフック」を参照してください。
-
プロジェクトのソースの場所を
CODEBUILD_DEFAULT_WEBHOOK_SOURCE_LOCATION
に設定します。 -
ウェブフックのスコープ設定で、組織かグローバルウェブフック
かに応じて、スコープを GITHUB_ORGANIZATION
またはGITHUB_GLOBAL
に設定します。詳細については、「Types of webhooks」を参照してください。 -
ウェブフックのスコープ設定の一部として名前を指定します。組織ウェブフックの場合、これは組織名であり、グローバルウェブフックの場合、これはエンタープライズ名です。
注記
プロジェクトのソースタイプが
GITHUB_ENTERPRISE
の場合、ウェブフックスコープ設定の一部としてドメインも指定する必要があります。 -
(オプション) 組織またはエンタープライズ内の特定のリポジトリのウェブフックイベントのみを受信する場合は、ウェブフックの作成時に
REPOSITORY_NAME
をフィルタとして指定できます。 -
組織ウェブフックを作成する場合は、CodeBuild に GitHub 内で組織レベルのウェブフックを作成するアクセス許可があることを確認してください。組織のウェブフックアクセス許可を持つ GitHub 個人用アクセストークンを作成するか、CodeBuild OAuth を使用できます。詳細については、「GitHub および GitHub Enterprise Server アクセストークン」を参照してください。
組織のウェブフックは、既存の GitHub ウェブフックイベントタイプのいずれでも動作することに注意してください。
-
グローバルウェブフックを作成する場合は、ウェブフックを手動で作成する必要があります。GitHub 内でウェブフックを手動で作成する方法の詳細については、「GitHub 手動ウェブフック」を参照してください。
グローバルウェブフックは
WORKFLOW_JOB_QUEUED
イベントタイプのみをサポートすることに注意してください。詳細については、「チュートリアル: CodeBuild がホストする GitHub Actions ランナーを設定」を参照してください。