Skip to main content

管理分支保护规则

可创建分支保护规则,为一个或多个分支强制实施某些工作流,例如要求进行审批评审或通过状态检查来确保所有拉取请求都已合并到受保护的分支的。

Who can use this feature

People with admin permissions to a repository can manage branch protection rules.

受保护分支适用于具有 GitHub AE 的内部和私有仓库,具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。

关于分支保护规则

可以在存储库中为特定分支、所有分支或者与使用 fnmatch 语法指定的命名模式匹配的任何分支创建分支保护规则。 例如,若要保护包含单词 release 的任何分支,可以为 *release* 创建分支规则。

可以使用通配符语法 * 为存储库中所有当前和未来的分支创建规则。 由于 GitHub 对 File.fnmatch 语法使用 File::FNM_PATHNAME 标志,因此通配符与目录分隔符 (/) 不匹配。 例如,qa/* 将匹配所有以 qa/ 开头并包含单个斜杠的分支。 可以用 qa/**/* 包含多个斜杠,也可以用 qa**/**/* 扩展 qa 字符串,以使规则更具包容性。 有关分支规则语法选项的详细信息,请参阅 fnmatch 文档

如果仓库有多个影响相同分支的受保护分支规则,则包含特定分支名称的规则具有最高优先级。 如果有多个受保护分支规则引用相同的特定规则名称,则最先创建的分支规则优先级更高。

提及特殊字符的受保护分支规则,如 *?],将按其创建的顺序应用,因此含有这些字符的规则创建时间越早,优先级越高。

要创建对现有分支规则的例外,您可以创建优先级更高的新分支保护规则,例如针对特定分支名称的分支规则。

有关每个可用分支保护设置的详细信息,请参阅“关于受保护的分支”。

创建分支保护规则

创建分支规则时,指定的分支不必是仓库中现有的分支。

  1. 在 your enterprise 上,导航到存储库的主页。 1. 在存储库名称下,单击 “设置”。 “存储库设置”按钮

  2. 在左侧菜单中,单击“分支”。 存储库选项子菜单 4. 在“分支保护规则”旁边,单击“添加规则”。 “添加分支保护规则”按钮

  3. 在“Branch name pattern(分支名称模式)”下,输入您要保护的分支名称或模式。 分支规则字段

  4. (可选)启用所需的拉取请求。

    • 在“保护匹配分支”下,选择“合并前需要拉取请求”。 拉取请求审阅限制复选框
    • (可选)若需要在合并拉取请求之前审批,选择“需要审批”,单击“合并前所需的审批数”下拉菜单,然后选择希望分支上要求的审批审阅数 。 用于选择必需审阅审批数量的下拉菜单
    • (可选)若要在将代码修改提交推送到分支时关闭拉取请求审批审阅,选择“推送新提交时关闭旧拉取请求审批”。 “推送新提交时关闭旧拉取请求审批”复选框
    • (可选)若要在拉取请求影响具有指定所有者的代码时要求代码所有者审阅,请选择“要求代码所有者审阅”。 有关详细信息,请参阅“关于代码所有者”。 要求代码所有者审阅
    • (可选)若要让特定参与者在需要时将代码推送到分支而不创建拉取请求,选择“允许指定参与者绕过所需的拉取请求”。 然后,搜索并选择应被允许跳过创建拉取请求的参与者。 “允许特定参与者绕过拉取请求要求”复选框
    • (可选)如果存储库是组织的一部分,选择“限制可以关闭拉取请求审阅的人员”。 然后,搜索并选择有权忽略拉取请求审查的参与者。 有关详细信息,请参阅“关闭拉取请求审阅”。 “限制可以关闭拉取请求审阅的人员”复选框
  5. (可选)启用必需状态检查。 有关详细信息,请参阅“关于状态检查”。

    • 选择“合并前需要通过状态检查”。 必需状态检查选项
    • (可选)若要确保使用受保护分支上的最新代码测试拉取请求,选择“要求分支在合并前保持最新”。 宽松或严格的必需状态复选框
    • 搜索状态检查,选择您想要求的检查。 可用状态检查的搜索界面,以及所需检查的列表
  6. (可选)选择“合并前需要对话解决”。 “合并前需要对话解决”选项

  7. (可选)选择“需要签名提交”。 需要签名提交选项

  8. (可选)选择“需要线性历史记录”。 需要线性历史记录选项

  9. (可选)选择“会将上述规则应用于管理员“将上述规则应用于管理员”复选框

  10. (可选)启用分支限制。

    • 选择“限制可推送到匹配分支的人员”。 “分支限制”复选框
    • 搜索并选择有权限推送到受保护分支或创建匹配分支的人员、团队或应用。 分支限制搜索
  11. (可选)在“适用于包括管理员在内的所有人的规则”下,选择“允许强制推送”。 允许强制推送选项 然后,选择可以强制推送到分支的人员。

    • 选择“所有人”,允许至少具有存储库写入权限的人强制推送到分支,包括具有管理员权限的人员。

    • 选择“指定可以强制推送的人员”,仅允许特定参与者强制推送到分支。 然后,搜索并选择这些参与者。 用于指定可以强制推送的人员的选项的屏幕截图

      有关强制推送的详细信息,请参阅“允许强制推送”。

  12. (可选)选择“允许删除”。 允许分支删除选项

  13. 单击“创建”。

编辑分支保护规则

  1. 在 your enterprise 上,导航到存储库的主页。 1. 在存储库名称下,单击 “设置”。 “存储库设置”按钮
  2. 在左侧菜单中,单击“分支”。 存储库选项子菜单
  3. 在要编辑的分支保护规则的右侧,单击“编辑”。 “编辑”按钮
  4. 对分支保护规则进行所需的更改。
  5. 单击“保存更改”。 “保存更改”按钮

删除分支保护规则

  1. 在 your enterprise 上,导航到存储库的主页。 1. 在存储库名称下,单击 “设置”。 “存储库设置”按钮
  2. 在左侧菜单中,单击“分支”。 存储库选项子菜单
  3. 在要删除的分支保护规则的右侧,单击“删除”。 “删除”按钮