GitLab

将文档与 GitLab 仓库同步

我们通过访问令牌与 webhooks 在 GitLab 与 Mintlify 之间进行身份验证并同步变更。

• Mintlify 使用访问令牌从 GitLab 拉取信息。
• GitLab 使用 webhooks 在发生变更时通知 Mintlify，从而为合并请求启用预览部署。

​

设置连接

必须使用 HTTPS 克隆：为便于 Mintlify 访问你的存储库，你的 GitLab 项目必须启用 HTTPS 克隆。你可以在 GitLab 中前往项目的 Settings > General > Visibility and access controls 部分进行查看与确认。

1. 查找项目 ID

   在你的 GitLab 项目中，依次进入 Settings > General，找到 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 Token 会过期，需要定期更新。

   
3. 设置连接

   在 Mintlify 控制台：

   1. 输入你的项目 ID 和访问令牌。
   2. 完成其他必填配置。
   3. 点击 保存更改。

   

​

创建 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（所有 branch）
   • Merge requests events

   完成后应如下所示：

   
5. 测试 Webhook

   创建 Webhook 后，点击“Test”下拉菜单并选择“Push events”，发送示例负载以确保配置正确。若配置无误，将显示“Hook executed successfully: HTTP 200”。

   这将帮助你验证一切正常工作，并确保你的文档能与 GitLab 存储库正确同步。