GitHub Webhook トリガーのコンテキスト

GitHub Webhook を使用してワークフローを自動実行すると、トリガーとなった GitHub イベントのメタデータがコンテキストとして自動生成されます。本記事では、各イベントで渡されるコンテキストフィールドの一覧を説明します。

コンテキストの動作

GitHub Webhook によってワークフローがトリガーされると、システムはイベントのペイロードからメタデータを抽出し、トリガーコンテキストとして構造化します。このコンテキストはワークフロー内の AI エージェントブロックのシステムプロンプトに自動的に付与されるため、AIは明示的な設定なしにトリガーのメタデータを参照できます。

全イベント共通フィールド

すべての GitHub Webhook イベントで常に渡されるフィールドです。

フィールド名	説明	例
event	トリガーとなったイベント種別	push、pull_request、release
repository	リポジトリのフルネーム	owner/repo-name
branch	ベースブランチ名	main、release/v2
sender	イベントを発生させたユーザーのログイン名	username

すべてのフィールドの値は文字列型として渡されます。数値（PR 番号など）も文字列で渡されます。

イベント別フィールド

プッシュ（push）

コードがブランチにプッシュされたときに渡される追加フィールドです。

フィールド名	説明	例
commitSha	HEAD コミットの SHA	abc123def456...
commitMessage	HEAD コミットのメッセージ	Fix: ログイン処理を修正
commitUrl	HEAD コミットの URL	https://github.com/owner/repo/commit/abc123
commitCount	プッシュに含まれるコミット数	3

プルリクエスト（pull_request）

プルリクエストが開かれた・更新された・閉じられたときに渡される追加フィールドです。

フィールド名	説明	例
action	PR に対して行われたアクション	opened、closed、synchronize
prNumber	PR の番号	42
prTitle	PR のタイトル	Feature: 新しいダッシュボード
prUrl	PR の URL	https://github.com/owner/repo/pull/42
headBranch	PR のソースブランチ	feature/new-dashboard
baseBranch	PR のターゲットブランチ	main
headSha	PR の HEAD コミット SHA	def456abc123...
merged	PR がマージ済みかどうか	true、false

リリース（release）

新しいリリースが公開されたときに渡される追加フィールドです。

フィールド名	説明	例
action	リリースに対して行われたアクション	published、created、edited
tagName	リリースのタグ名	v1.2.3
releaseName	リリースの名称	Version 1.2.3
releaseUrl	リリースの URL	https://github.com/owner/repo/releases/tag/v1.2.3
prerelease	プレリリースかどうか	true、false

コンテキストの参照方法

AI エージェントブロックのシステムプロンプトには、以下のような形式でトリガーコンテキストが自動的に付与されます。

## Trigger Context
This workflow was automatically triggered. Here is the trigger metadata:
- **type**: github
- **event**: push
- **repository**: owner/repo-name
- **branch**: main
- **sender**: username
- **commitSha**: abc123def456...
- **commitMessage**: Fix: ログイン処理を修正
- **commitUrl**: https://github.com/owner/repo/commit/abc123
- **commitCount**: 1

AI エージェントブロックのプロンプトに「コミットメッセージを要約してください」と書くだけで、AI はコンテキストからコミット情報を自動的に参照できます。

関連ページ

• ワークフローの実行

• GitHub連携