设置代码扫描合并保护

保护代码库，禁止未通过 code scanning 检查的拉取请求。

谁可以使用此功能？

具有管理员角色的组织所有者、安全管理员和组织成员

Code scanning 可用于以下存储库类型：

  • GitHub.com 上的公共存储库
  • GitHub Team、GitHub Enterprise Cloud 或 GitHub Enterprise Server 上的组织拥有的存储库，已启用 GitHub Code Security。

本文内容

为存储库创建合并保护规则集

  1. 在 GitHub 上，导航到存储库的主页面。1. 在仓库名称下，单击 “Settings”****。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。
    1. 在左侧边栏的“代码和自动化”下，单击“规则”，然后单击“规则集” 。

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

  2. 单击“添加规则集”。****

  3. 要创建针对分支的规则集，请单击“新建分支规则集”****。

  4. 在“规则集名称”下，键入规则集的名称。

  5. （可选）若要更改默认强制实施状态，请单击 “Disabled”，并选择强制实施状态****。1. 在“分支保护”下，选择“要求 code scanning 结果。

  6. 在“Required tools and alert thresholds”下，单击 “Add tool”****，然后从下拉列表中选择 code scanning 工具。 例如，“CodeQL”。

  7. code scanning 工具的名称旁边：

    • 单击“警报”，然后选择“无”、“错误”、“错误和警告”或“全部”。
    • 单击“安全警报”，然后选择“无”、“严重”、“高或更高”、“中”或“全部”。

    “规则集”设置的“所需工具和警报阈值”部分的屏幕截图。

有关警报严重性和安全严重性级别的详细信息，请参阅“关于代码扫描警报”。

有关在存储库中管理规则集的详细信息，请参阅 管理存储库的规则集。

使用 REST API 创建合并保护规则集

可以使用 REST API 通过 code_scanning 规则创建规则集，以便定义特定工具和设置警报阈值。 有关详细信息，请参阅“规则的 REST API 终结点”。