Skip to main content
自定义自动化使用你编写的指令，按计划、在仓库推送时或在已连接的集成事件发生时运行 agent。当预定义自动化无法覆盖你需要的行为，或者你希望将自己的提示词与特定的上下文仓库和集成组合在一起时，使用自定义自动化。有关所有自动化共享的触发器、更新模式和配置选项的概述，请参见自动化。

​
前置条件

  • 一个已连接到 GitHub、GitLab 或 Bitbucket 仓库的 Mintlify 项目
  • 对于 GitHub：在你计划用于自动化的每个仓库上都安装 Mintlify GitHub 应用
  • 对于 GitLab：已连接的 GitLab 账户（请参见下方GitLab 设置）
  • 对于 Bitbucket：已连接的 Bitbucket 账户（请参见下方Bitbucket 设置）

​
创建自定义自动化

agent 运行在受限互联网访问的隔离沙箱中。它无法在运行时安装额外的包或工具。引用不可用工具的提示词可能产生意外结果或失败。
  1. 在控制台中打开 Automations 页面。
  2. 点击 Create a custom automation。
  3. 配置自动化名称、触发器、指令、上下文仓库、集成和更新模式。有关各字段的详细说明，请参见配置。
  4. 点击 Create automation。
你也可以让 Slack 中的 agent 为你创建自动化，只需描述你希望该自动化执行的操作。

​
撰写有效的指令

有效的自动化指令聚焦于单一任务，并定义清晰、可验证的结果。由于 agent 是非确定性的，自动化结果会有所差异，但格式良好的指令能产生更一致的结果。
  • 描述结果。 告诉 agent 一次成功的运行应该是什么样的。
  • 撰写流程。 给 agent 一份按步骤执行的指南。
  • 保持范围窄。 将复杂任务拆分到多个自动化中，而不是合并到一个提示词里。
更多示例和模式请参见使用自动化。
审查你自定义自动化的输出，以确认它们按预期运行。更新你的指令以改进结果。

​
GitLab 设置

要在自动化中使用 GitLab 仓库，请通过 GitLab OAuth 设置页面连接每个项目。请连接自动化涉及的所有仓库——你的文档仓库以及任何触发或上下文仓库。你必须在每个项目中至少具有 Maintainer 角色。
自动化需要付费的 GitLab 套餐。代理使用短期项目访问令牌来访问仓库，GitLab 的 Free 套餐不支持此功能。

​
Bitbucket 设置

要在自动化中使用 Bitbucket 仓库，请通过 Mintlify 控制台中的 Bitbucket OAuth 设置连接 Bitbucket 账户。授权 Mintlify 访问你的 Bitbucket 工作区，然后选择自动化可以使用的工作区和仓库。Mintlify 会列出你的 Bitbucket 账户拥有贡献者访问权限的仓库。连接自动化用于内容更新、代码变更触发器或上下文的仓库。Mintlify 会为每个已连接的仓库注册 webhook，以便仓库事件可以触发自动化。在将已连接的 Bitbucket 仓库配置为部署 Git 源之前，请在 Bitbucket OAuth 设置中连接该仓库。Mintlify 要求仓库属于有效的 Bitbucket 安装，才能将其用作 Git 源。

​
配置 Bitbucket 部署

  1. 在控制台中打开 Git 设置，选择 Connect to Bitbucket，然后点击 Continue。
  2. 如果 Mintlify 当前托管你的文档，点击 Download 将内容保存为 zip 文件。创建 Bitbucket 仓库，上传 zip 文件中的内容，然后点击 Continue setup。连接自己的仓库会永久删除已托管的内容，因此请在继续前下载内容。
  3. 点击 Connect Bitbucket，授权 Mintlify 访问你的工作区和仓库。
  4. 输入 Bitbucket 工作区 slug、仓库 slug 和部署分支。如果 docs.json 位于子目录中，启用 Docs are in a subdirectory，并输入包含 docs.json 的目录路径。
  5. 点击 Connect。
对于已连接并配置为部署 Git 源的仓库，推送到配置的分支会触发部署。Mintlify 能确定差异时，会使用变更文件执行增量更新。如果无法确定变更文件，或变更会影响整个站点，则会执行完整更新。如果已启用预览部署，修改文档内容的拉取请求可以创建预览部署。关闭拉取请求或删除其源分支会移除匹配的预览部署。合并拉取请求会清理相关的编辑器分支。Mintlify 会在处理事件前验证 webhook 签名。没有有效签名的请求会被拒绝。来自未识别仓库的事件会被忽略。要停止使用某个仓库，请在 Bitbucket OAuth 设置中断开连接。你也可以移除 Bitbucket 安装，以断开与该授权关联的所有仓库。

​
删除自定义自动化

删除自动化是永久性的，会移除其配置和运行历史。
  1. 在控制台中打开 Automations 页面。
  2. 点击自动化旁边的 设置按钮。
  3. 点击 Delete。