管理存储库的规则集

可以在存储库中编辑、监视和删除现有规则集，以更改用户与特定分支和标记进行交互的方式。

谁可以使用此功能？

对存储库具有读取访问权限的任何人都可以查看存储库的规则集。 对仓库具有管理员访问权限的人员或者具有“编辑仓库规则”权限的自定义角色可以为仓库创建、编辑和删除规则集。

规则集在具有 GitHub Free 和 GitHub Free（适用于组织）的公共存储库中可用，在具有 GitHub Pro、GitHub Team 和 GitHub Enterprise Cloud 的公共和专用存储库中可用。 有关详细信息，请参阅 GitHub的计划。

推送规则集适用于内部存储库和专用存储库中的 GitHub Team 计划，以及已启用推送规则集的存储库分支。

在本文中

创建规则集之后，可以对其进行更改。 例如，可以添加规则以更好地保护分支或标记，也可以在 参与者体验的影响后将其从“评估”模式切换到“活动”，暂时禁用规则集，以排查对存储库参与者体验的任何意外影响。

可以使用 REST API 和 GraphQL API 来管理规则集。 有关详细信息，请参阅 规则的 REST API 终结点 和 突变。

查看存储库的规则集

在“规则集”页上，对存储库具有读取访问权限的任何人都可以查看针对特定 分支、标记或推送限制的活动规则集。

对于已创建分支的存储库的推送规则集，“规则集”页面将指示规则集由应用规则的源存储库管理。

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在左侧的文件树状视图中，选择 分支下拉菜单，然后单击“View all branches”****。 还可以在集成的文件编辑器顶部找到分支下拉菜单。

    存储库的文件树视图的屏幕截图。 分支的下拉菜单已展开，并用深橙色框出。

  3. 在分支名称的左侧，单击 。

    提示

    只有具有规则集的分支具有 与其名称相邻的图标。

  4. （可选）若要筛选结果，请单击选项卡，或使用“搜索分支”搜索栏。

  5. 单击要查看的规则集的名称。

还可以通过以下方式查看活动规则集：

  • 通过将 /rules 数据域添加到存储库的 URL。 例如，若要查看 GitHub 开放源代码 文档存储库的规则，请转到 https://github.com/github/docs/rules。

  • 在合并框中（如果有规则阻止合并拉取请求）。

编辑规则集

可以通过编辑规则集更改规则集的某些部分，例如名称、绕过权限或规则。 还可以编辑规则集更改其状态，例如在需要启用或暂时禁用规则集时。

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在仓库名称下，单击 “Settings”****。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“规则集” 。

    存储库“设置”页边栏的屏幕截图。 “规则”子菜单已展开，“规则集”选项以橙色轮廓突出显示。

  4. 在“规则集”页面上，单击要编辑的规则集的名称。

  5. 根据需要更改规则集。 有关可用规则的信息，请参阅“规则集的可用规则”。

  6. 在页面的底部，单击“保存更改”。

删除规则集

提示

如果要暂时禁用某个规则集，但不想将其删除，可以将规则集的状态设置为“Disabled”。 有关详细信息，请参阅“编辑规则集”。

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在仓库名称下，单击 “Settings”****。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“规则集” 。

    存储库“设置”页边栏的屏幕截图。 “规则”子菜单已展开，“规则集”选项以橙色轮廓突出显示。

  4. 单击要删除的规则集的名称。

  5. 在规则集名称右侧，选择 ，然后单击“ Delete ruleset”****。

    用于编辑规则集的页面的屏幕截图。 在标有三个点的按钮下方，一个标有“删除规则集”的选项以橙色框出。

导入规则集

可以使用 JSON 文件导入现有规则集。 如果要将相同规则集应用于多个存储库或组织，这种方法很有用。

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在仓库名称下，单击 “Settings”****。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“规则集” 。

    存储库“设置”页边栏的屏幕截图。 “规则”子菜单已展开，“规则集”选项以橙色轮廓突出显示。

  4. 选择“新建规则集”**** 下拉列表，然后单击“导入规则集”****。

    存储库规则集的页面屏幕截图。 “新建规则集”下拉菜单展开，以橙色框出了“导入规则集”选项。

  5. 打开导出的 JSON 文件。

  6. 查看导入的规则集，然后单击“创建”****。

查看规则集的见解

可以查看规则集的见解，了解规则集如何影响存储库。 在“规则见解”页面上，会看到以下用户操作的时间线。 可以使用筛选器来查找要查找的内容。

  • 已根据一个或多个规则集进行检查并通过的操作。
  • 根据一个或多个规则集检查过并失败的操作。
  • 有人绕过一条或多条规则的行为。

如果规则集在“评估”模式下运行，则可以看到规则集处于活动状态时会通过或失败的操作。

此外，这些见解通过规则套件 REST API 提供。

“规则见解”页面的屏幕截图。 列出了三个操作，标记为“通过”、“绕过”和“失败”。 失败的操作具有“评估”标签。

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在仓库名称下，单击 “Settings”****。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“见解”。********

    存储库“设置”页边栏的屏幕截图。 “规则”子菜单已展开，“见解”选项以橙色轮廓突出显示。

  4. 在“规则见解”页上，可使用页面顶部的下拉菜单按规则集、分支、执行者和时间段筛选操作。

  5. 若要查看哪些特定规则失败或需要绕过，请单击 ，然后展开规则集的名称。

    “规则见解”页面的屏幕截图。 在标有“不允许”的事件的右侧，以橙色框出了三个水平点的图标。

规则洞察仪表板

注意

规则见解仪表板目前处于 公共预览版 阶段，且可能会发生变化。 它可用于 GitHub Team 和 GitHub Enterprise Cloud 计划。

规则见解仪表板提供存储库规则评估活动的直观高级摘要，包括：

  •         **一段时间内的成功、失败和绕过**：显示规则评估结果趋势的图表，可帮助你发现受阻推送或异常模式的峰值。

  •           **顶级绕过者**：针对你的规则集最活跃的绕过者列表。

每个图表都链接到预先填充筛选器的规则见解页面，让你能快速深入了解特定状态、绕行者或时间范围。

若要查看仪表板，请执行以下操作：

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在仓库名称下，单击 “Settings”****。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“见解”。********

  4. 在“规则见解”页面顶部，查看仪表板图表，了解规则评估活动的概述。