通过 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 用来接收外部请求并触发 pipeline 的入口。你可以通过多种方式获取此 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 仓库

Jenkins 将立即开始构建

在 Jenkins 中查看控制台输出和测试结果

常见平台的 Webhook 文档

通过 Git Commit 触发测试

核心原理：事件触发 + CLI 命令执行#

常见 CI/CD 集成示例#

跨平台集成示例：GitHub Actions + Jenkins#

场景#

步骤 1：配置 Jenkins 项目#

步骤 2：获取 Webhook URL#

步骤 3：配置 GitHub Webhook#

结果验证#

常见平台的 Webhook 文档#