Skip to main content

管理组织中存储库的规则集

可以编辑、监视和删除现有规则集,以更改用户与组织中的存储库进行交互的方式。

谁可以使用此功能?

Organization owners and users with the "Manage organization ref update rules and rulesets" permission can manage rulesets at the organization level.

关于管理组织的规则集

在组织级别创建规则集后,可以对规则集进行更改,以更改用户与目标存储库进行交互的方式。 例如,可以添加规则以更好地保护这些存储库中的分支或标记,也可以在测试规则集对存储库参与者体验的影响后,将规则集从“评估”模式切换到“可用”模式。 应用于存储库分支的组织规则集将不再允许存储库管理员重命名目标存储库的分支或将默认分支更改为另一个分支。 存储库管理员可创建和删除分支,只要其具有适当的权限。

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

Note

对存储库具有读取访问权限的任何人都可以查看该存储库上运行的活动规则集。

编辑规则集

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

  1. 在 GitHub 的右上角,选择个人资料照片,然后单击“你的组织”。

  2. 在组织旁边,单击“设置”。

  3. 在左侧边栏的“代码、规划和自动化”部分,单击“ 存储库”,然后单击“规则集”。********

    组织的设置页面的屏幕截图。 在边栏中,标有“规则集”的链接以橙色轮廓突出显示。

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

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

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

删除规则集

Tip

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

  1. 在 GitHub 的右上角,选择个人资料照片,然后单击“你的组织”。

  2. 在组织旁边,单击“设置”。

  3. 在左侧边栏的“代码、规划和自动化”部分,单击“ 存储库”,然后单击“规则集”。********

    组织的设置页面的屏幕截图。 在边栏中,标有“规则集”的链接以橙色轮廓突出显示。

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

  5. 在规则集名称右侧,选择 ,然后单击“ 删除规则集”。

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

查看规则集的见解

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

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

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

“规则见解”页面的屏幕截图。 列出了三个操作:一个标记为“通过”,一个标记为“绕过”,一个标记为“失败”并带有“评估”标签。

  1. 在 GitHub 的右上角,选择个人资料照片,然后单击“你的组织”。

  2. 在组织旁边,单击“设置”。

  3. 在左侧边栏的“代码、规划和自动化”部分,单击“ 存储库”,然后单击“规则见解”。

    组织的设置页面的屏幕截图。 在边栏中,标有“规则见解”的链接以橙色轮廓突出显示。

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

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

    “规则见解”页面的屏幕截图。 在标记为“不允许创建 octocat”的事件的右侧,三个水平点的图标以橙色框出。