27.2. GitLab Webhook の設定

手順

1. Automation Controller で使用する Personal Access Token (PAT) を生成します。

   1. GitLab のナビゲーションパネルから、アバターを選択して、プロファイルを編集 します。
   2. ナビゲーションパネルから Access tokens を選択します。

   3. 以下のフィールドに入力します。

      • Token name: この PAT が何に使用されるかについて、簡単な説明を入力します。
      • Expiration date: Webhook の有効期限を設定しない場合は、このフィールドをスキップします。
      • Select scopes: 統合に適用できるスコープを選択します。Automation Controller の場合、必要な選択は API のみです。

   4. Create personal access token をクリックします。

      重要

      トークンが生成されたら、ステップ 2 で必要となるため、必ず PAT をコピーしてください。GitLab ではこのトークンに再度アクセスすることはできません。

2. 必要に応じて、PAT を使用して、GitLab の認証情報を作成します。

   1. インスタンスに移動し、生成されたトークンを使用して GitLab PAT の新しい認証情報を作成します。

   2. GitLab にポストバックするジョブテンプレートで使用するため、この認証情報の名前をメモしておきます。

      

   3. Webhook を有効にするジョブテンプレートに移動し、前の手順で作成した Webhook サービスと認証情報を選択します。

      
   4. Save をクリックします。ジョブテンプレートは GitLab にポストバックするように設定されています。
3. Webhook を設定する GitLab リポジトリーに移動します。
4. ナビゲーションパネルから、Settings Integrations を選択します。
5. Add webhook ページを完了するには、ジョブテンプレートまたはワークフロージョブテンプレートで Enable Webhook オプションをオンにする必要があります。詳細は、ジョブテンプレートの作成 および ワークフロージョブテンプレートの作成 のステップ 3 を参照してください。

6. 以下のフィールドに入力します。

   • URL: Webhook URL の内容をジョブテンプレートからコピーし、ここに貼り付けます。結果は GitLab からこのアドレスに送信されます。
   • Secret Token: ジョブテンプレートから Webhook Key の内容をコピーし、ここに貼り付けます。
   • Trigger: Webhook をトリガーするイベントのタイプを選択します。このようなイベントがあれば、ジョブまたはワークフローがトリガーされます。ジョブのステータス (pending, error, success) を GitLab に送り返すには、Trigger セクションで Merge request events を選択する必要があります。
   • SSL verification: Enable SSL verification を選択したままにします。
7. Add webhook をクリックします。
8. Webhook が設定されると、リポジトリーの Project Webhooks リストに表示され、イベントのテスト、Webhook の編集または削除を行うことができます。Webhook イベントをテストすると、成功したか失敗したかの結果が各ページに表示されます。