跳至主要内容

自定义自动分类规则以优先处理 Dependabot 警报

您可以创建自己的自动分类规则来控制哪些警报被关闭或延迟,以及您希望 Dependabot 为哪些警报打开拉取请求。

谁可以使用此功能?

  • 组织所有者
  • 安全管理员
  • 具有**管理员**访问权限的用户(可以启用、禁用和查看存储库的自动分类规则,以及创建自定义自动分类规则)

关于自定义自动分类规则

您可以根据警报元数据创建自己的 Dependabot 自动分类规则。您可以选择无限期地自动关闭警报,或将警报延迟到补丁可用时,并且您可以指定您希望 Dependabot 为哪些警报打开拉取请求。

由于您创建的任何规则都适用于未来和当前的警报,因此您还可以使用自动分类规则批量管理您的 Dependabot 警报。

存储库管理员可以为其公共存储库创建自定义自动分类规则。

组织所有者和安全管理员可以在组织级别设置自定义自动分类规则,然后选择在组织中的所有公共存储库中强制执行或启用规则。

  • **强制执行**:如果组织级规则为“强制执行”,则存储库管理员无法编辑、禁用或删除该规则。
  • **启用**:如果组织级规则为“启用”,则存储库管理员仍可以为其存储库禁用该规则。

注意

如果组织级规则和存储库级规则指定了冲突的行为,则组织级规则设置的操作优先。关闭规则始终在触发 Dependabot 拉取请求的规则之前执行。

您可以使用以下元数据创建用于定位警报的规则

  • CVE ID
  • CWE
  • 依赖关系范围(devDependencyruntime
  • 生态系统
  • GHSA ID
  • 清单路径(仅限存储库级规则)
  • 包名称
  • 补丁可用性
  • 严重性

了解自定义自动分类规则和 Dependabot 安全更新如何交互

您可以使用自定义自动分类规则来定制您希望 Dependabot 为哪些警报打开拉取请求。但是,要使“打开拉取请求”规则生效,您必须确保已为应应用规则的存储库(或存储库)禁用 Dependabot 安全更新。

当为存储库启用 Dependabot 安全更新时,Dependabot 将自动尝试打开拉取请求以解决具有可用补丁的**所有**打开的 Dependabot 警报。如果您希望使用规则自定义此行为,则必须保持 Dependabot 安全更新处于禁用状态。

有关为存储库启用或禁用 Dependabot 安全更新的更多信息,请参阅“配置 Dependabot 安全更新”。

将自定义自动分类规则添加到您的存储库

注意

在公开预览期间,您可以为存储库创建最多 10 个自定义自动分类规则。

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

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

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

  3. 在侧边栏的“安全”部分,单击** 代码安全和分析**。

  4. 在“Dependabot 警报”下,单击靠近“Dependabot 规则”。

  5. 单击**新建规则**。

  6. 在“规则名称”下,描述此规则将执行的操作。

  7. 在“状态”下,使用下拉菜单选择规则对于存储库是否应启用或禁用。

  8. 在“目标警报”下,选择要用于筛选警报的元数据。

  9. 在“规则”下,选择您希望对与元数据匹配的警报执行的操作。

    • 选择**关闭警报**以自动关闭与元数据匹配的警报。您可以选择无限期关闭警报,或直到有补丁可用。
    • 如果您希望 Dependabot 建议更改以解决与目标元数据匹配的警报,请选择**打开拉取请求以解决此警报**。请注意,如果您已选择无限期关闭警报选项,或者如果您的存储库设置中启用了 Dependabot 安全更新,则此选项不可用。
  10. 点击**创建规则**。

向您的组织添加自定义自动分类规则

您可以为组织中所有符合条件的存储库添加自定义自动分类规则。有关更多信息,请参阅“配置组织的全局安全设置”。

编辑或删除存储库的自定义自动分类规则

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

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

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

  3. 在侧边栏的“安全”部分,单击** 代码安全和分析**。

  4. 在“Dependabot 警报”下,单击靠近“Dependabot 规则”。

  5. 在“存储库规则”下,在您要编辑或删除的规则右侧,单击.

  6. 要编辑规则,请对相关字段进行任何更改,然后单击**保存规则**。

  7. 要删除规则,请在“危险区域”下,单击**删除规则**。

  8. 在“您确定要删除此规则吗?”对话框中,查看信息,然后单击**删除规则**。

编辑或删除组织的自定义自动分类规则

您可以编辑或删除组织中所有符合条件的存储库的自定义自动分类规则。有关更多信息,请参阅“配置组织的全局安全设置”。