简介
可以创建规则集来控制用户如何与存储库中的选定分支和标记交互。 可以控制谁可以将提交推送到特定分支以及提交的格式必须如何设置，或者谁可以删除或重命名标记。 还可以阻止用户重命名存储库。
还可以创建推送规则集来阻止对专用或内部存储库的推送，以及对存储库整个分支网络的推送。 推送规则集允许根据文件扩展名、文件路径长度、文件和文件夹路径，以及文件大小阻止推送。
创建规则集时，可以允许某些用户绕过规则集中的规则。
有关规则集的详细信息，请参阅“关于规则集”。
对于订阅 GitHub Team 和 GitHub Enterprise 计划的客户，你还可以在组织中创建仓库规则集。 有关详细信息，请参阅“创建组织中存储库的规则集”。
导入预生成的规则集
若要通过 GitHub 导入其中一个预生成规则集，请参阅github/ruleset-recipes。
可以使用 JSON 文件导入现有规则集。 如果要将相同规则集应用于多个存储库或组织，这种方法很有用。 有关更多信息，请参阅“管理组织中存储库的规则集”。
使用 fnmatch 语法
创建规则集时，可以使用 fnmatch 语法来定义要针对的模式。
可以使用 * 通配符来匹配任何字符串。 由于 GitHub 对 File.fnmatch 语法使用 File::FNM_PATHNAME 标记，因此 * 通配符与目录分隔符 (/) 不匹配。 例如，qa/* 将匹配以 qa/ 开头并包含单个斜杠的所有分支，但不会匹配 qa/foo/bar。 可以使用 qa/**/* 在 qa 后面包含任意数量的斜杠，这将匹配 qa/foo/bar/foobar/hello-world。 还可以使用 qa**/**/* 扩展 qa 字符串，以使规则更具包容性。
有关语法选项的详细信息，请参阅 fnmatch 文档。
不支持的 fnmatch 语法
并非 fnmatch 语法中的所有表达式都受分支保护规则支持。 请注意以下约束条件：
- 不能将反斜杠 (
\) 字符用作引号，因为 GitHub 不支持在分支保护规则中使用反斜杠。 - 可以在方括号 (
[]) 中指定字符集，但当前不能用^运算符（例如[^charset]）来补充该字符集。 - 尽管 GitHub 支持
fnmatch语法中的File::FNM_PATHNAME，但不支持File::FNM_EXTGLOB。
使用规则集强制实施状态
创建或编辑规则集时，可以使用强制状态来配置规则集的强制实施方式。
可以为规则集选择以下任何强制状态。
- 活动：规则集创建后便会强制实施。****
- 已禁用：不会强制实施规则集。****
创建分支或标签规则集
-
在 GitHub 上，导航到存储库的主页面。
-
在存储库名称下，单击 “设置”。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。
-
在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“规则集” 。
-
单击“添加规则集”。****
-
若要创建面向分支的规则集，请单击“新建分支规则集”。 或者，若要创建针对标签的规则集，请单击“新建标签规则集”****。
-
在“规则集名称”下，键入规则集的名称。
-
（可选）若要更改默认强制实施状态，请单击 “已禁用”**** 并选择强制实施状态。 有关强制状态的详细信息，请参阅关于规则集。
为分支或标签规则集授予旁路权限
你可以授予特定角色、团队或应用绕过权限 的功能。 以下项符合绕过访问的条件：
- 存储库管理员、组织所有者和企业所有者
- 维护或写入角色，或是基于写入角色的自定义存储库角色
- 团队（机密团队除外）。 请参阅“关于团队”。
- GitHub Apps
- Dependabot。 有关 Dependabot 的详细信息，请参阅“Dependabot 快速入门指南”。
-
若要授予规则集的绕过权限，请在“Bypass list”部分中单击 “Add bypass”****。
-
在显示的“添加绕过”模式对话框中，搜索要授予绕过权限的角色、团队或应用，然后从“建议”部分选择角色、团队或应用，然后单击“添加所选”****。
-
（可选）若要向执行组件授予旁路权限，而不允许它们直接推送到存储库，请在“始终允许”右侧单击 ，然后单击“仅针对拉取请求”****。
现在，选择的执行组件需要打开拉取请求才能对存储库进行更改，从而创建其拉取请求和审核日志更改的清晰痕迹。 然后，参与者可以选择绕过任何分支保护，以及合并该拉取请求。
选择要作为目标的分支或标签
若要定位分支或标记，在“目标分支”或“目标标记”部分，选择“添加目标”****，然后选择包含或排除分支或标记的方式。 可以使用 fnmatch 语法基于模式包含或排除分支或标记。 有关详细信息，请参阅“使用 fnmatch 语法”。
可以将多个目标条件添加到同一规则集。 例如，可以包含默认分支，包含与模式 *feature* 匹配的任何分支，然后专门排除与模式 not-a-feature 匹配的分支。
选择分支或标记保护
在“分支保护”或“标记保护”部分中，选择要包含在规则集中的规则。 选择规则时，可以输入规则的其他设置。 有关规则的详细信息，请参阅“规则集的可用规则”。
注意
如果选择“Require status checks before merging”，请在“Additional settings”部分执行以下操作：****
- 可以输入所需的每个状态检查的名称。 若要完成添加状态检查作为要求，必须单击 。
- 如果选择“合并前要求分支保持最新状态”，则必须定义检查才能使保护生效。
添加元数据限制
元数据限制应旨在提高存储库中提交之间的一致性。 它们不是要取代安全措施（例如要求通过拉取请求进行代码评审）。
注意
如果 Squash 合并分支，该分支上的所有提交都必须满足基础分支的任何元数据要求。
-
若要添加用于控制提交元数据或分支名称的规则，请在创建或编辑规则集时在“限制”部分单击“限制提交元数据”或“限制分支名称”********。
-
配置限制的设置，然后单击“添加”****。 可以向同一规则集添加多个限制。
-
若要匹配指定正则表达式模式，请在“要求”下拉列表中选择“必须与指定正则表达式模式匹配”****。
对于大多数要求（如“必须从匹配模式开始”），输入的模式按字面解释，不支持通配符。 例如，
*字符仅表示文本*字符。对于更复杂的模式，可以选择“必须匹配给定的正则表达式模式”或“不能匹配给定的正则表达式模式”，然后使用正则表达式语法来定义匹配模式。 有关详细信息，请参阅 GitHub Enterprise Cloud 文档中的“关于适用于提交元数据的正则表达式”。
查看存储库规则集的任何人都可以看到你提供的说明。
-
（可选）在制定具有元数据限制的规则集之前，可以为规则集选择“评估”强制状态，以测试任何元数据限制的影响，而不会影响参与者。 有关元数据限制的详细信息，请参阅“规则集的可用规则”。
完成分支或标签规则集和后续步骤
单击“创建****”即可完成规则集的创建。 如果规则集的强制执行状态设置为“活动”，规则集会立即生效。
创建推送规则集
注意
此规则集将强制实施存储库整个分支网络的推送限制。
你可以为专用或内部存储库创建推送规则集。
-
在 GitHub 上，导航到存储库的主页面。
-
在存储库名称下，单击 “设置”。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。
-
在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“规则集” 。
-
单击“添加规则集”。****
-
若要创建针对分支的规则集，请单击“新建推送规则集”****。
-
在“规则集名称”下，键入规则集的名称。
-
（可选）若要更改默认强制实施状态，请单击 “已禁用”**** 并选择强制实施状态。 有关强制状态的详细信息，请参阅关于规则集。
为推送规则集授予旁路权限
注意
此存储库中推送规则集的旁路权限将由此存储库的整个分支网络继承。 这意味着，在此存储库的整个分支网络中，唯一可以绕过此规则集的用户是在根存储库中可以绕过此规则集的用户。
你可以授予特定角色、团队或应用绕过权限 的功能。 以下项符合绕过访问的条件：
- 存储库管理员、组织所有者和企业所有者
- 维护或写入角色，或是基于写入角色的自定义存储库角色
- 团队（机密团队除外）。 请参阅“关于团队”。
- GitHub Apps
- Dependabot。 有关 Dependabot 的详细信息，请参阅“Dependabot 快速入门指南”。
- 若要授予规则集的绕过权限，请在“Bypass list”部分中单击 “Add bypass”****。
- 在显示的“添加绕过”模式对话框中，搜索要授予绕过权限的角色、团队或应用，然后从“建议”部分选择角色、团队或应用，然后单击“添加所选”****。
选择推送保护
你可以阻止对此存储库以及对此存储库整个分支网络的推送，具体取决于文件扩展名、文件路径长度、文件和文件夹路径以及文件大小。
配置的任何推送保护都会阻止此存储库中的推送，并在此存储库的整个分支网络中阻止推送。
-
在“推送保护”下，单击你要应用的限制。 然后填写你所选限制的详细信息。
对于文件路径限制，你可以使用部分路径或完整路径。 可以为此使用
fnmatch语法。 例如，针对test/demo/**/*的限制可阻止对test/demo/目录中的文件或文件夹进行任何推送。 针对test/docs/pushrules.md的限制可阻止对pushrules.md目录中test/docs/文件的专门推送。 有关详细信息，请参阅“创建存储库的规则集”。
完成推送规则集和后续步骤
单击“创建****”即可完成规则集的创建。 如果规则集的强制执行状态设置为“活动”，规则集会立即生效。