跳转到主要内容
自动化需要 Pro 或 Enterprise 方案。
自动化会按计划或在仓库发生变更时自动运行 agent。每个自动化都会为 agent 定义一个提示词，以及触发其运行的条件。自动化同时支持 GitHub 和 GitLab 仓库，二者具备相同的触发器、预定义自动化和更新模式。在本指南中，除非另有说明，“pull request” 也指 GitLab 的 merge request。 当自动化运行时，agent 会读取你的项目内容以及任何已连接的仓库，然后按照提示词进行更新。
对于周期性任务，例如发布更新日志或审计 SEO 元数据，使用按计划运行的自动化。对于响应式维护任务，例如翻译或在源代码变更时更新内容，使用由内容或代码变更触发的自动化。

​
触发器类型

自动化支持三种触发器类型。
  • 内容更新（Content update）：当内容推送到你的 Mintlify 项目仓库时运行，包括 pull request 合并和直接推送。
  • 代码变更（Code change）：当已连接的源代码仓库中有 pull request 合并时运行。
  • 自定义计划（Custom schedule）：按周期性计划运行。自动化会在预定时间的 10 分钟内进入队列。
每个自动化只能有一个触发器。你无法在单个自动化中组合多种触发器类型。

​
Pull request 分组

自动化会将相关更改分组到单个 pull request 中，而不是为每个更改都打开一个单独的 pull request。当后续运行产生的更多更改属于某个已打开的 pull request 时，agent 会将这些更改追加到该 pull request，而不是另开重复的 pull request。分组方式因自动化而异。请参阅预定义自动化了解每个自动化的具体行为。
Draft changelog、Draft improvements from assistant conversations、Draft improvements from user feedback、Update from support feedback 以及自定义自动化不会分组或追加。每次运行都会以本次运行的更改单独打开一个 pull request。Update from support feedback 每次运行最多可打开三个 pull request，为其识别出的每个不同主题各打开一个。

​
审查自动化 pull request

当自动化打开或更新 pull request 时，Mintlify 会直接在其中添加上下文，让你无需离开 GitHub 或 GitLab 即可进行审查。
  • PR 标题 包含生成它的自动化名称，方便你在浏览未关闭 PR 列表时一眼识别自动化 PR。
  • PR 描述 总结了变更内容和原因。每当某次运行向已有 PR 追加新变更时，描述都会更新，显示一份记录每次运行所贡献内容的时间线。
  • PR 评论 用于任何追加变更的运行，说明所做的变更以及 agent 使用了哪些源代码 pull request 作为上下文。
  • 审阅者 根据触发本次更新的源代码变更的作者分配。适用于在 GitHub 上以源代码仓库作为上下文的自动化。GitLab 不支持自动分配审阅者，因此请在 merge request 上手动指定审阅者。

​
使用限制

自动化运行会计入你的积分使用量。单次运行消耗的积分取决于任务规模：agent 读取的内容量、变更的文件数量以及运行时长。上下文仓库越大、提示词越宽泛，使用的积分就比范围窄的运行更多。 可在控制台的 Usage 页面查看积分使用情况、设置超额用量并管理你的积分套餐。 每个自动化每天最多可运行 500 次。失败的运行不计入此限制。

​
后续步骤

预定义自动化

所有预定义自动化的参考：触发器、更新模式和必需配置。

管理自动化

启用预定义自动化并配置触发器、更新模式和上下文。

创建自定义自动化

使用你自己的触发器、指令和上下文仓库构建自动化。

学习最佳实践

选择合适的触发器、撰写有效的指令并审查结果。