简介
您可以创建规则集来控制用户如何与代码库中选定的分支和标签进行交互。您可以控制诸如谁可以将提交推送到特定分支以及提交必须如何格式化，或者谁可以删除或重命名标签等内容。您还可以阻止用户重命名代码库。
您还可以创建推送规则集，以阻止对私有或内部代码库及其整个分支网络的推送。推送规则集允许您根据文件扩展名、文件路径长度、文件和文件夹路径以及文件大小来阻止推送。
创建规则集时，您可以允许某些用户绕过规则集中的规则。
有关规则集的更多信息，请参阅“关于规则集”。
导入预建规则集
要导入 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 应用
- Dependabot。有关 Dependabot 的更多信息，请参阅“Dependabot 快速入门指南”。
-
要授予规则集的绕过权限，请在“绕过列表”部分中，单击 添加绕过.
-
在出现的“添加绕过”模态对话框中，搜索您要授予绕过权限的角色、团队或应用，然后从“建议”部分中选择角色、团队或应用，然后单击添加所选。
-
可选：要授予参与者绕过权限，而无需允许他们直接推送到代码库，请在“始终允许”右侧单击，然后单击仅限拉取请求。
现在，选定的参与者需要打开拉取请求才能对代码库进行更改，并在拉取请求和审核日志中创建其更改的清晰跟踪。然后，参与者可以选择绕过任何分支保护并合并该拉取请求。
选择要定位的分支或标签
要定位分支或标签，请在“目标分支”或“目标标签”部分中，选择添加目标，然后选择您希望如何包含或排除分支或标签。您可以使用 fnmatch 语法根据模式包含或排除分支或标签。有关更多信息，请参阅“使用 fnmatch 语法”。
您可以将多个目标条件添加到同一规则集。例如，您可以包含默认分支，包含与模式 *feature* 匹配的任何分支，然后专门排除与模式 not-a-feature 匹配的分支。
选择分支或标签保护
在“分支保护”或“标签保护”部分中，选择您希望包含在规则集中的规则。当您选择规则时，您可能能够为该规则输入其他设置。有关规则的更多信息，请参阅“规则集的可用规则”。
注意
如果您选择合并前需要状态检查，请在“其他设置”部分
- 您可以输入您想要要求的每个状态检查的名称。要完成将状态检查添加为要求，您必须单击.
- 如果您选择合并前需要分支是最新的，则必须为保护定义一个检查才能生效。
添加元数据限制
您的元数据限制应旨在提高代码库中提交之间的一致性。它们并非旨在替代安全措施，例如通过拉取请求要求代码审查。
注意
如果您压缩合并分支，则该分支上的所有提交都必须满足基分支的任何元数据要求。
-
要添加规则以控制提交元数据或分支名称，请在创建或编辑规则集时的“限制”部分中，单击限制提交元数据或限制分支名称。
-
配置限制的设置，然后单击添加。您可以将多个限制添加到同一规则集。
-
要匹配给定的正则表达式模式，请在“要求”下拉列表中选择必须匹配给定的正则表达式模式。
对于大多数要求，例如“必须以匹配的模式开头”，您输入的模式将按字面解释，并且不支持通配符。例如，
*字符仅表示字面*字符。对于更复杂的模式，您可以选择“必须匹配给定的正则表达式模式”或“必须不匹配给定的正则表达式模式”，然后使用正则表达式语法定义匹配模式。有关更多信息，请参阅 GitHub Enterprise Cloud 文档中的“关于提交元数据的正则表达式”。
任何查看代码库规则集的人员都将能够看到您提供的描述。
-
可选：在使用元数据限制执行规则集之前，请为规则集选择“评估”执行状态，以测试任何元数据限制的效果，而不会影响贡献者。有关元数据限制的更多信息，请参阅“规则集的可用规则”。
完成分支或标签规则集并执行后续步骤
要完成创建规则集，请单击创建。如果规则集的执行状态设置为“活动”，则规则集将立即生效。
创建推送规则集
注意
此规则集将为该存储库的整个 fork 网络强制执行推送限制。
您可以为私有或内部存储库创建推送规则集。
-
在 GitHub 上，导航到代码库的主页。
-
在您的代码库名称下，单击 设置。如果您看不到“设置”选项卡，请选择下拉菜单，然后单击设置。
-
在左侧边栏的“代码和自动化”下，单击规则，然后单击规则集。
-
单击新建规则集。
-
要创建针对分支的规则集，请点击新建推送规则集。
-
在“规则集名称”下，键入规则集的名称。
-
可选：要更改默认执行状态，请单击 禁用 并选择执行状态。有关执行状态的更多信息，请参阅“关于规则集”。
授予推送规则集的绕过权限
注意
此存储库中推送规则集的绕过权限将由该存储库的整个 fork 网络继承。这意味着，对于该存储库的整个 fork 网络中的任何存储库，唯一可以绕过此规则集的用户是可以在根存储库中绕过此规则集的用户。
您可以为规则集授予某些角色、团队或应用绕过权限。以下人员有资格获得绕过访问权限
- 代码库管理员、组织所有者和企业所有者
- 维护或写入角色，或基于写入角色的自定义代码库角色
- 团队
- 部署密钥
- GitHub 应用
- Dependabot。有关 Dependabot 的更多信息，请参阅“Dependabot 快速入门指南”。
- 要授予规则集的绕过权限，请在“绕过列表”部分中，单击 添加绕过.
- 在出现的“添加绕过”模态对话框中，搜索您要授予绕过权限的角色、团队或应用，然后从“建议”部分中选择角色、团队或应用，然后单击添加所选。
选择推送保护
您可以根据文件扩展名、文件路径长度、文件和文件夹路径以及文件大小阻止对此存储库及其整个 fork 网络的推送。
您配置的任何推送保护都将阻止对此存储库及其整个 fork 网络的推送。
-
在“推送保护”下，点击您想要应用的限制。然后填写您选择的限制的详细信息。
对于文件路径限制，您可以使用部分或完整路径。您可以为此使用
fnmatch语法。例如，针对test/demo/**/*的限制会阻止对test/demo/目录中任何文件或文件夹的任何推送。针对test/docs/pushrules.md的限制会阻止专门对test/docs/目录中的pushrules.md文件的推送。有关更多信息，请参阅“为存储库创建规则集”。
完成推送规则集和后续步骤
要完成创建规则集，请单击创建。如果规则集的执行状态设置为“活动”，则规则集将立即生效。