跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://mintlify-docs-automerge-setup-requirements.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

配置你的仓库，使 Mintlify GitHub 应用能够创建和合并 pull request 而审查和状态检查要求不会阻止它。这允许你配置工作流程以自动将更改合并到 main。 自动合并要求你的仓库满足两个条件：
  1. 启用了 squash 合并。 Mintlify 使用 squash 合并来合并 PR。
  2. Mintlify GitHub 应用可以绕过分支规则。 将该应用添加到每个针对你部署分支并要求审查的规则集或经典分支保护规则的绕过列表中。
如果缺少这两个条件之一，仪表盘会在你的 Workflows 页面上显示自动合并设置横幅。使用横幅中的链接直接跳转到你需要更新的 GitHub 设置。
Mintlify GitHub 应用必须对所有针对你部署分支的规则集和分支保护规则都拥有绕过权限，包括在组织级和仓库级定义的规则。如果任何规则缺少绕过条目，工作流程会创建 PR，但不会将其合并。

​
前提条件

  • 仓库管理员权限（如果有组织级规则集，还需要组织管理员权限）
  • 在仓库中安装了 Mintlify GitHub 应用
  • 在仓库中启用了 squash 合并
  • 一个或多个针对 main 分支的规则集或分支保护规则（在组织级或仓库级）

​
启用 squash 合并

  1. 在 GitHub 上，进入仓库的 Settings -> General。
  2. 在 Pull Requests 下，选择 Allow squash merging。
  3. 点击 Save。
如果 squash 合并被禁用，即使所有分支规则的绕过配置都正确，自动合并也无法完成合并。

​
将 Mintlify GitHub 应用添加到你的分支规则

对适用于你部署分支的每个规则集重复以下步骤。包括组织级和仓库级的规则集。
1

导航到规则集

  • 仓库规则集：在 GitHub 上，进入仓库的 Settings -> Rules -> Rulesets。
  • 组织规则集：进入组织的 Settings -> Rules -> Rulesets。
2

选择规则集

点击一个针对你部署分支的规则集，通常是 main。
3

将 Mintlify GitHub 应用添加到绕过列表

  1. 在 Bypass list 下，点击 Add bypass。
  2. 搜索并选择 Mintlify GitHub 应用。
  3. 将绕过模式设置为 Always。
4

保存

点击 Save changes。
5

对剩余规则集重复操作

如果你有其他针对部署分支的组织级或仓库级规则集，请对每个规则集重复步骤 2 至 4。
如果你的仓库使用经典分支保护规则（而不是规则集，或者除了规则集之外还使用），请打开 Settings -> Branches，编辑保护你部署分支的规则，并将 Mintlify GitHub 应用添加到 Allow specified actors to bypass required pull requests。

​
验证设置

  1. 对于贡献者：打开一个针对 main 的 PR。确认它仍然需要批准和通过状态检查后你才能合并。
  2. 对于工作流程：触发启用了自动合并的工作流程。确认工作流程运行并成功合并 PR。
  3. 在仪表盘中：打开 Workflows 页面，确认自动合并设置横幅不再显示。