Skip to main content

管理存储库的规则集

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

谁可以使用此功能?

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

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

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

创建规则集之后,可以对其进行更改。 例如,可以添加规则以更好地保护分支或标签,也可以在测试规则集对存储库的参与者体验产生的影响后,暂时禁用规则集,以排查对存储库参与者体验产生的任何意外影响 。

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

查看存储库的规则集

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

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

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

  2. 在左侧的文件树视图中,选择 分支下拉菜单,然后单击“查看所有分支”。 还可以在集成的文件编辑器顶部找到分支下拉菜单。

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

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

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

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

编辑规则集

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

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

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

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

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

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

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

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

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

删除规则集

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

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

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

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

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

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

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

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

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

使用规则集历史记录

注意:

  • 规则集历史记录目前为公共 beta 版本,可能会有变动。
  • 规则集历史记录仅包含 2023 年 10 月 11 日公开 beta 版本之后对规则集所做更改。

可以查看规则集的所有更改并还原回特定迭代。 还可以在特定迭代中下载包含规则集配置的 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. 查看导入的规则集,然后单击“创建”****。