GitHub のウェブトリガー

GitHub のウェブトリガーは、GitHub リポジトリまたは組織の イベントを監視するように設定されています。

概要

GitHub ウェブトリガーは、a GitHub 組織または リポジトリ内の特定のイベントをリッスンします。 組織またはリポジトリでイベントが発生すると、トリガーが設定された自動化ワークフローを開始します。

認証

GitHubウェブトリガーは、ユーザー認証のためにパーソナル アクセ ストークンを使用します。OAuth接続は必要ありません。 パーソナル アクセス トークン の作成と管理の詳細については、パーソナル アクセス トークンの管理 を参照してください。 GitHubウェブトリガーは、クラシックおよびファイングレイン アクセス トークンをサポートしています。 パーソナル アクセス トークン が有効であることを確認してください。

このトークンは Credential Vault に保存できます。 資格情報の保存と管理に関する詳細は、Credential Vault の資格情報と lockersをご覧ください。

サポートされているイベント

GitHub ウェブトリガーは、組織レベルとリポジトリレベルの両方で以下のイベントをサポートしています:

イベント 内容
作成 ファイル、ブランチ、またはタグが作成されたとき。
フォーク リポジトリがフォークされたとき。
コメント発行 イシューまたはプルリクエストにコメントが追加された場合。
イシュー リポジトリレベルで課題が作成されるとき。
ラベル 課題またはプルリクエストにラベルが追加されたとき、またはラベルが削除されたとき。
プルリクエスト リポジトリ内のブランチでプルリクエストが作成されたとき。
プルリクエスト レビュー プルリクエストにレビュー コメントが追加されたとき。
プッシュ リポジトリのブランチへのプッシュがあるとき。
スター リポジトリがスターを付けられた場合
視聴 リポジトリ内の特定のイベントに対してウォッチオプションが有効になっているとき。

前提条件

次の前提条件が満たされていることを確認してください。

  • Bot Creator または Citizen Developer のライセンス。
  • マイ Bot を表示イベントトリガー 権限。
  • チェックイン および チェックアウト 権限が自動化が存在するフォルダーに必要です。
  • アクティブな GitHub パーソナル アクセス トークン

設定

GitHub のウェブトリガーには、次の設定があります。

GitHub組織のウェブトリガーのスクリーンショット

GitHubリポジトリのウェブトリガー設定のスクリーンショット

イベントを聞く
トリガーが監視すべきイベントを1つ以上選択してください。
組織名
GitHub 組織名を入力します。 このフィールドは GitHub 組織のウェブトリガーのみに適用されます。
リポジトリ名
GitHub 組織内のリポジトリ名を入力してください。 このフィールドは GitHub リポジトリのウェブトリガーにのみ適用されます。
ユーザープロフィール
GitHub ユーザープロファイルを入力します。 このフィールドは GitHub リポジトリのウェブトリガーにのみ適用されます
認証タイプを選択する
パーソナル アクセス トークン はデフォルトの認証タイプです。 Credential Vault に保存されている パーソナル アクセス トークン資格情報l オプションの 選択 で選択するか、安全でない文字列 オプションに パーソナル アクセス トークン を直接入力することができます。
応答(任意)
トリガー応答データを Record 変数に保存するには、レスポンスオプションを使用してください。 新しい変数を作成するか、既存の変数を選択してこの応答データを保存できます。 トリガー応答データは、GitHub ウェブフック API ペイロード応答ボディからの情報をキーとバリューのペア形式でキャプチャします。 Record 変数内でこのデータを他のアクションの入力として使用できるように、キーを名前として使用します。
GitHub ウェブトリガーは、ドット (.) 表記を使用してウェブフックのキー-バリューペア ペイロードを解析します。 Record 変数の式を構築するには、同じ形式に従う必要があります。 例えば、レポジトリ ID を式として使用するには、repository.id をキーとして入力する必要があります。 GitHub の Webhook ペイロードのドキュメントの詳細については、「GitHub webook events and payload」を参照してください。
Bot の実行が完了すると、Audit log はトリガーイベントによって実行された Bot でトリガーの応答データを記録します。