跳至主要内容

管理仓库的规则集

您可以编辑、监控和删除仓库中现有的规则集,以更改人们如何与特定分支和标签进行交互。

谁可以使用此功能?

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

规则集在使用 GitHub Free 和 GitHub Free for organizations 的公共仓库中可用,在使用 GitHub Pro、GitHub Team 和 GitHub Enterprise Cloud 的公共和私有仓库中可用。有关更多信息,请参阅“GitHub 的计划”。

推送规则集适用于内部和私有仓库中的 GitHub Team 计划,以及启用了推送规则集的仓库的分支。

创建规则集后,您仍然可以对其进行更改。例如,您可以添加规则以更好地保护您的分支或标签,或者您可以暂时禁用规则集以解决对仓库贡献者体验的任何意外影响。

您可以使用 REST 和 GraphQL API 来管理规则集。有关更多信息,请参阅“规则的 REST API 端点”和“Mutations”。

查看仓库的规则集

在“规则集”页面上,任何拥有仓库读取权限的人都可以查看针对特定分支、标签或推送限制的活动规则集。

对于分叉仓库的推送规则集,“规则集”页面将指示规则集由应用规则的源仓库管理。

  1. 在 GitHub.com 上,导航到仓库的主页。

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

    Screenshot of the file tree view for a repository. A dropdown menu for branches is expanded and outlined in dark orange.

  3. 在分支名称左侧,点击 .

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

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

编辑规则集

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

  1. 在 GitHub.com 上,导航到仓库的主页。

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

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

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

    Screenshot of the sidebar of the "Settings" page for a repository. The "Rules" sub-menu is expanded, and the "Rulesets" option is outlined in orange.

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

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

  6. 在页面底部,点击 **保存更改**。

删除规则集

**提示:**如果您想暂时禁用规则集但不希望删除它,可以将规则集的状态设置为“已禁用”。有关更多信息,请参阅“编辑规则集”。

  1. 在 GitHub.com 上,导航到仓库的主页。

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

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

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

    Screenshot of the sidebar of the "Settings" page for a repository. The "Rules" sub-menu is expanded, and the "Rulesets" option is outlined in orange.

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

  5. 在规则集名称的右侧,选择 ,然后点击 ** 删除规则集**。

    Screenshot of the page for editing a ruleset. Below a button labeled with three dots, an option labeled "Delete ruleset" is outlined in orange.