跳转到主要内容
将 Mintlify GitHub 应用添加到规则集的绕过列表中,使该应用能够创建和合并 pull request 而不会被审查和状态检查要求阻止。这允许你配置工作流程以自动将更改合并到 main
Mintlify GitHub 应用必须对所有针对你部署分支的规则集都拥有绕过权限,包括在组织级和仓库级定义的规则集。如果任何规则集缺少绕过条目,工作流程会创建 PR,但不会将其合并。

前提条件

  • 仓库管理员权限(如果有组织级规则集,还需要组织管理员权限)
  • 在仓库中安装了 Mintlify GitHub 应用
  • 一个或多个针对 main 分支的规则集(在组织级或仓库级)

步骤

对适用于你部署分支的每个规则集重复以下步骤。包括组织级仓库级的规则集。
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。

验证设置

  1. 对于贡献者:打开一个针对 main 的 PR。确认它仍然需要批准和通过状态检查后才能启用合并按钮。
  2. 对于工作流程:触发启用了自动合并的工作流程。确认工作流程运行并成功合并 PR。