前置条件
- 一个已连接到 GitHub 或 GitLab 仓库的 Mintlify 项目
- 对于 GitHub：在你计划用于自动化的每个仓库上都安装 Mintlify GitHub 应用
- 对于 GitLab：已连接的 GitLab 账户（请参见下方GitLab 设置）
启用自动化
- 在控制台中打开 Automations 页面。
-
点击自动化旁边的开关以启用它。
如果自动化可以使用默认设置运行，它会立即激活。否则，设置面板会打开，让你填写任何必需的配置。
- 如果设置面板打开，请填写必填字段。
- 点击 Turn on automation。
配置
触发器
- 内容更新（Content update）：每当你向项目仓库推送内容时运行，包括 pull request 合并和直接推送。
- 代码变更（Code change）：当已连接的源代码仓库中有 pull request 合并时运行。你必须至少指定一个源仓库。
- 自定义计划（Custom schedule）：按你定义的周期性计划运行。自动化会在预定时间的 10 分钟内进入队列。
更新模式
对于 GitHub 仓库，自动更新要求 Mintlify GitHub 应用对所有针对部署分支的规则集（包括组织级和仓库级规则集）拥有绕过权限。设置说明请参见配置 automerge。对于 GitLab 仓库，automerge 使用 GitLab OAuth 连接，并且要求每个项目至少具有 Maintainer 角色。
上下文仓库
集成
Slack 通知
- 在你的工作区安装 Mintlify Slack 应用。
-
在控制台的 Automations 页面点击 Turn on Slack notifications。
- 选择一个或多个通知频道。
- 点击 Save changes。
- 自动化打开了 pull request 等待审查。
- 自动化的 pull request 已等待审查三天。
- 自动化合并了 pull request 或未能完成。
指令
目标语言
- Mintlify 会读取你
docs.json中定义的languages以识别默认语言，并预选已配置的目标语言。 - 你必须至少选择一个目标语言才能保存自动化。
- 你无法选择源语言作为目标。
禁用自动化
- 进入控制台中的 Automations 页面。
- 点击自动化旁边的开关以禁用它。
查看运行历史
- 进入控制台中的 Automation Runs 页面。
-
使用下拉菜单按特定自动化或状态进行过滤。
