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 终结点突变

注意

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

编辑规则集

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

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

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

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

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

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

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

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

删除规则集

提示

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

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

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

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

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

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

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

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

使用规则集历史记录

注意

只有在 2023 年 10 月 11 日的 公共预览版 发布之后对规则集所做的更改,才会包含在规则集历史记录中。

可以查看规则集的所有更改并还原回特定迭代。 还可以在特定迭代中下载包含规则集配置的 JSON 文件。 规则集的绕过列表已从导出的 JSON 文件中排除。

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

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

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

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

  4. 要查看规则集更改历史记录,在规则集名称右侧选择 ,然后单击“ 历史记录”****。

    存储库规则集的页面屏幕截图。 在标有三个点的按钮下方,标有“历史记录”的选项以橙色标出。

  5. 在特定迭代右侧选择 % octicon "kebab-horizontal" aria-label="Open additional options" %},然后单击“比较更改”、“还原” 或“下载”****。

    存储库规则集历史记录的页面屏幕截图。 标有三个点的下拉菜单展开并以橙色边框突出显示。

导入规则集

可以使用上一部分导出的 JSON 文件从另一个存储库或组织导入规则集。 如果要将相同规则集应用于多个存储库或组织,这种方法很有用。

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

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

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

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

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

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

  5. 打开导出的 JSON 文件。

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