我们使用访问令牌和 webhook 在 GitLab 与 Mintlify 之间进行身份验证并同步变更。
  • Mintlify 使用访问令牌从 GitLab 拉取信息。
  • GitLab 使用 webhook 在发生变更时通知 Mintlify，从而为合并请求启用预览部署。

​
设置连接

1

查找项目 ID

在你的 GitLab 项目中，依次进入 Settings > General，找到 Project ID。
GitLab 仪表盘的 General Settings 页面，已高亮显示 Project ID。
2

生成访问令牌

前往 Settings > Access Tokens，选择 Add new token。按以下配置生成令牌：
  • Name：Mintlify
  • Role：Maintainer（私有仓库必需）
  • Scopes：api 和 read_api
点击 Create project access token 并复制该令牌。
如果无法使用 Project Access Tokens，可改用 Personal Access Token。请注意，Personal Access Tokens 会过期，需定期更新。
GitLab 仪表盘的 Access tokens 页面，已高亮显示为 Mintlify 配置的选项。
3

设置连接

在 Mintlify 仪表盘：
  1. 输入你的项目 ID 和访问令牌。
  2. 完成其他必填配置。
  3. 点击 Save Changes。
Mintlify 仪表盘的 Git Settings 页面，已高亮显示 GitLab 配置项。

​
创建 webhook

Webhooks 允许我们在发生更改时接收事件，从而自动触发部署。
1

导航到 Settings > Webhooks 并点击“Add new Webhook”

2

设置 URL 和 webhook

在“URL”字段中输入端点 https://leaves.mintlify.com/gitlab-webhook，并将 webhook 命名为“Mintlify”。
3

粘贴令牌

粘贴在完成连接设置后生成的 Webhook 令牌。
4

选择事件

选择以下事件以触发 webhook：
  • Push events（所有分支）
  • Merge requests events
完成后应如下所示：
GitLab 控制台中的 Webhook 页面。为 Mintlify 配置的设置已高亮显示。
5

测试 Webhook

创建 Webhook 后，点击“Test”下拉菜单并选择“Push events”以发送示例负载，确保配置正确。若配置无误，将显示“Hook executed successfully: HTTP 200”。这将帮助你验证一切正常运行，并确保文档能与 GitLab 仓库正确同步。