Git コミットによるテストのトリガー

手動操作なしで、Git コミットイベント（push、pull request など）を通じて Apidog の自動テストを自動的にトリガーできます。この機能は、GitHub Actions、Jenkins、GitLab CI など、あらゆる CI/CD プラットフォームで動作します。

基本原理：イベントトリガー + CLI コマンド実行

Git コミット後に Apidog テストを自動的にトリガーする仕組みは、汎用的な原理に基づいています。

Webhook を使用する場合でも、CI/CD プラットフォームが提供する組み込みイベントリスナー（例：GitHub Actions の on: push）を使用する場合でも、本質は同じです。
Git コミットイベントを監視し、Apidog のテストコマンドを実行します。

CI/CD 環境が Git コミットに応答し、コマンドラインスクリプトを実行できる限り、Apidog の自動テストを統合できます。

一般的に、トリガーメカニズムには次の 2 種類があります。

1. 組み込みイベントメカニズム（例：GitHub Actions、GitLab CI）

たとえば、GitHub Actions では次のようなイベント設定が提供されています。

この方法では Webhook の設定は不要です。プラットフォームが内部でイベントを監視するため、軽量なアプローチです。

2. 外部 Webhook（例：Jenkins、セルフホストサービス）

Jenkins またはクロスプラットフォーム構成を使用する場合、通常は Webhook を手動で設定する必要があります。

一般的な CI/CD 統合例

組み込みイベントメカニズムを通じて自動テストをトリガーする場合：

Github Actions との統合

Gitlab との統合

クロスプラットフォーム統合例：GitHub Actions + Jenkins

シナリオ

コードリポジトリは GitHub でホストされています

パイプライン実行環境は Jenkins です

GitHub Webhook を使用して Jenkins パイプラインをトリガーします

Jenkins で apidog run を実行し、Apidog の自動テストを実行します

ステップ 1：Jenkins プロジェクトを設定する

Integrate with Jenkins を参照してプロジェクトを作成し、正常に設定してください。

ステップ 2：Webhook URL を取得する

Webhook URL は、Jenkins が外部リクエストを受信してパイプラインをトリガーするために使用するエントリーポイントです。この URL は、Generic Webhook Trigger プラグインを使用するなど、複数の方法で取得できます。

Jenkins Plugin Manager で「Generic Webhook Trigger」プラグインを検索してインストールします。インストール後、Jenkins を再起動します。

Generic Webhook Trigger プラグインを表示している Jenkins プラグインマネージャー

Jenkins Dashboard でプロジェクトを選択し、Configure に移動します。Generic Webhook Trigger を有効にします。
Webhook URL は次のとおりです：http://<your Jenkins host>/generic-webhook-trigger/invoke

トークンを定義することもできます。その場合、Webhook URL は次のようになります。
http://<your Jenkins host>/generic-webhook-trigger/invoke?token=<xxxxxx>

保存後、Webhook URL をコピーします。この URL は Jenkins のテスト実行をトリガーするために使用されます。

ステップ 3：GitHub Webhook を設定する

「GitHub リポジトリ → Settings → Webhooks → Add webhook」に移動します。

Payload URL：http://<your Jenkins host>/generic-webhook-trigger/invoke?token=<xxxxxx>

Content type：application/json

Secret：任意

Which events would you like to trigger this webhook?：Just the push event またはその他のトリガーイベントを選択します

「Add webhook」をクリックします

これで、コードが push されるたびに、Jenkins が自動的にトリガーされ、設定済みのテストタスクを実行します。

結果の確認

GitHub リポジトリにコードを push します

Jenkins が直ちにビルドを開始します

Jenkins でコンソール出力とテスト結果を確認します

一般的なプラットフォームの Webhook ドキュメント

Git コミットによるテストのトリガー

基本原理：イベントトリガー + CLI コマンド実行#

一般的な CI/CD 統合例#

クロスプラットフォーム統合例：GitHub Actions + Jenkins#

シナリオ#

ステップ 1：Jenkins プロジェクトを設定する#

ステップ 2：Webhook URL を取得する#

ステップ 3：GitHub Webhook を設定する#

結果の確認#

一般的なプラットフォームの Webhook ドキュメント#