GitLab

将文档与 GitLab 仓库同步

我们使用访问令牌和 webhook 在 GitLab 与 Mintlify 之间进行身份验证并同步更改。

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

​

设置连接

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. 点击 Save Changes。

   

​

创建 Webhook

Webhook 可在发生更改时向我们发送事件，从而自动触发部署。

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

   完成后应如下所示：

   
5. 测试 Webhook

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

   这有助于你确认一切正常运行，并确保你的文档能与 GitLab 仓库正确同步。