透過 Git Commit 觸發測試

你可以透過 Git commit 事件（例如 push、pull request）自動觸發 Apidog 自動化測試，無需任何手動介入。此功能適用於任何 CI/CD 平台，包括 GitHub Actions、Jenkins、GitLab CI 等。

核心原則：事件觸發 + CLI 命令執行

在 Git commit 後自動觸發 Apidog 測試，是基於一個通用原則：

無論是透過 Webhook，還是 CI/CD 平台提供的內建事件監聽器（例如 GitHub Actions 中的 on: push），本質都是相同的：
監控 Git commit 事件並執行 Apidog 的測試命令。

只要你的 CI/CD 環境能夠回應 Git commit 並執行命令列指令碼，就可以整合 Apidog 自動化測試。

通常有兩種觸發機制：

1. 內建事件機制（例如 GitHub Actions、GitLab CI）

以 GitHub Actions 為例，它提供如下事件設定：

此方法不需要設定 Webhook。平台會在內部監控事件，是一種輕量化的方法。

2. 外部 Webhooks（例如 Jenkins、自架服務）

使用 Jenkins 或跨平台設定時，通常需要手動設定 Webhooks。

常見 CI/CD 整合範例

透過內建事件機制觸發自動化測試：

與 Github Actions 整合

與 Gitlab 整合

跨平台整合範例：GitHub Actions + Jenkins

情境

程式碼儲存庫託管於 GitHub

Pipeline 執行環境為 Jenkins

使用 GitHub Webhook 觸發 Jenkins pipeline

在 Jenkins 中執行 apidog run 來執行 Apidog 自動化測試

步驟 1：設定 Jenkins 專案

請參考與 Jenkins 整合來建立專案並成功完成設定。

步驟 2：取得 Webhook URL

Webhook URL 是 Jenkins 用來接收外部請求並觸發 pipelines 的入口點。你可以透過多種方式取得此 URL，例如使用 Generic Webhook Trigger 外掛程式。

在 Jenkins Plugin Manager 中，搜尋並安裝「Generic Webhook Trigger」外掛程式。安裝後重新啟動 Jenkins。

Jenkins 外掛程式管理員顯示 Generic Webhook Trigger 外掛程式

在 Jenkins Dashboard 中，選擇你的專案並前往 Configure。啟用 Generic Webhook Trigger。
Webhook URL 為：http://<your Jenkins host>/generic-webhook-trigger/invoke

你也可以定義 token。Webhook URL 會變成：
http://<your Jenkins host>/generic-webhook-trigger/invoke?token=<xxxxxx>

儲存後，複製 Webhook URL。此 url 將用於觸發 Jenkins 測試執行。

步驟 3：設定 GitHub Webhook

前往你的「GitHub repository → 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 執行已設定的測試任務。

結果驗證

將程式碼 push 到你的 GitHub repository

Jenkins 會立即開始 build

在 Jenkins 中查看 console output 和測試結果

常見平台的 Webhook 文件

透過 Git Commit 觸發測試

核心原則：事件觸發 + CLI 命令執行#

常見 CI/CD 整合範例#

跨平台整合範例：GitHub Actions + Jenkins#

情境#

步驟 1：設定 Jenkins 專案#

步驟 2：取得 Webhook URL#

步驟 3：設定 GitHub Webhook#

結果驗證#

常見平台的 Webhook 文件#