前置条件
- 一个已连接到 GitHub 或 GitLab 仓库的 Mintlify 项目
- 对于 GitHub：在你计划用于自动化的每个仓库上都安装 Mintlify GitHub 应用
- 对于 GitLab：已连接的 GitLab 账户（请参见下方GitLab 设置）
启用自动化
- 在控制台中打开 Automations 页面。
- 点击自动化旁边的开关以启用它。 如果自动化可以使用默认设置运行，它会立即激活。否则，该自动化的配置页面会打开，让你填写任何必需的配置。
- 如果配置页面打开，请填写必填字段并点击 Save。
配置
触发器
- 内容更新（Content update）：每当你向项目仓库推送内容时运行，包括 pull request 合并和直接推送。
- 代码变更（Code change）：当已连接的源代码仓库中有 pull request 合并时运行。你必须至少指定一个源仓库。点击 Add repo 可让来自多个仓库的 pull request 触发该自动化。对于每个仓库，你可以选择设置 Exclude author 来忽略来自特定作者的 pull request，以及 Listening to changes in 仅在特定路径下有变更的 pull request 时触发。
- 自定义计划（Custom schedule）：按你定义的周期性计划运行。选择一个预设（Daily、Every Monday、Every Friday 或 Twice weekly）以及起始小时，或选择 Custom cron 并输入标准的 5 段式 cron 表达式（
minute hour day month weekday）。自动化会在预定时间的 10 分钟内进入队列。 - 集成（Integration）：当已连接的共享集成中发生所选事件时运行，或当在所选 Slack 频道中发布新消息时运行。此选项适用于自定义自动化。请选择集成和事件，并填写出现的任何其他事件字段。对于 Slack 触发器，请选择一个或多个已添加 Mintlify Slack 应用的频道。
- Webhook：当一个已认证的
POST请求命中自动化的 webhook 端点时运行。仅适用于自定义自动化。先保存自动化。触发器卡片随后会显示 webhook URL 和用于Authorization: Bearer <api-key>请求头的 Copy auth header 操作。在 API keys 页面提供一个具有写入权限且未过期的组织 API 密钥。可用于从 CI/CD 流水线、发布脚本或内部工具触发运行。有关端点和速率限制，请参见触发自动化 webhook。
过滤代码变更触发器
- Listening to changes in：添加 pull request 必须涉及的路径，自动化才会运行。路径可以是文件、文件夹或 glob 模式（例如
docs/**/*.mdx）。建议来自仓库中被跟踪的文件；你也可以输入自定义路径。 - Excluding PRs from：添加不应触发自动化的 GitHub 用户名或机器人账户。适合跳过自动化账户的合并操作。建议来自近期的贡献者；你也可以输入自定义用户名。
更新模式
对于 GitHub 仓库，自动更新要求 Mintlify GitHub 应用对所有针对部署分支的规则集（包括组织级和仓库级规则集）拥有绕过权限。设置说明请参见配置 automerge。对于 GitLab 仓库，automerge 使用 GitLab OAuth 连接，并且要求每个项目至少具有 Maintainer 角色。
上下文仓库
集成
Slack 通知
- 在你的工作区安装 Mintlify Slack 应用。
- 在控制台的 Automations 页面点击 Configure Slack。
- 选择一个或多个用于接收通知的频道。
- 点击 Save changes。
- 自动化打开了 pull request 等待审查。
- 自动化的 pull request 已等待审查三天。
- 自动化合并了 pull request 或未能完成。
电子邮件通知
指令
目标语言
- Mintlify 会读取你
docs.json中定义的languages以识别默认语言，并预选已配置的目标语言。 - 你必须至少选择一个目标语言才能保存自动化。
- 你无法选择源语言作为目标。
GitLab 设置
自动化需要付费的 GitLab 套餐。代理使用短期项目访问令牌来访问仓库，GitLab 的 Free 套餐不支持此功能。
禁用自动化
- 进入控制台中的 Automations 页面。
- 点击自动化旁边的开关以禁用它。
删除自动化
- 在控制台中打开 Automations 页面。
- 点击自定义自动化卡片上的 设置按钮以打开其配置页面。
- 点击页面底部的 Delete automation 并确认。
手动运行自动化
- 在控制台中打开 Automations 页面。
- 点击自动化卡片上的 设置按钮以打开其配置页面。
- 点击运行按钮（根据自动化不同，为 Test run 或 Run now）。
- 选择运行范围。
- Since a date：审查从所选日期到当前时间的更改。日期默认为该自动化的上次运行时间；如果从未运行过，则默认为七天前。
- Everything：审查整个站点或仓库历史。此范围通常比定向运行耗时更长。
- Specific pull request：将运行限制为所选仓库中的一个 pull request。
- 点击 Run now。
通过 API 触发计划自动化
触发 webhook 自动化
POST 请求到达其 webhook 端点时运行。保存自动化后，打开其配置页面即可复制 webhook URL 并查看 Authorization: Bearer <api-key> 请求头模板。将 <api-key> 替换为在 API keys 页面创建的、具有写入权限且未过期的组织 API 密钥。自动化不会为你创建、存储或轮换密钥。
通过 webhook 触发的运行使用自动化保存的提示词，读取完整的仓库历史，并在运行历史中以 Webhook request 标签显示。有关请求格式、响应代码和速率限制，请参见触发自动化 webhook。
查看运行历史
- 进入控制台中的 Automations 页面。
- 使用下拉菜单按特定自动化或状态进行过滤。
- Review needed：agent 已完成运行，但更改需要你团队中的成员审查并合并。
- Running：agent 正在执行该自动化任务。
- Accepted：agent 已完成运行，更改已合并到你的仓库。
- Closed：agent 已完成运行，但有人拒绝了这些更改。
- Failed：agent 无法完成运行。
- No action needed：agent 完成了运行，但未发现需要更新的内容。
- Modified PR：该结果将更改追加到了先前运行打开的 pull request 中。