Skip to main content

使用任务列表跟踪问题中的代码扫描警报

您可以使用任务列表将代码扫描警报添加到议题中。 这样可以轻松创建包括修复警报在内的开发工作计划。

If you have write permission to a repository you can track 代码扫描 alerts in issues using task lists.

代码扫描 is available for all public repositories on GitHub.com. 代码扫描 is also available for private repositories owned by organizations that use GitHub Enterprise Cloud and have a license for GitHub Advanced Security. 更多信息请参阅“GitHub 的产品”。

注意: 议题中 代码扫描 警报的跟踪处于测试阶段,可能会发生更改。

此功能支持使用 GitHub Actions 在本地运行分析,或使用现有 CI/CD 基础结构以及第三方 代码扫描 工具在外部运行分析,但使用第三方跟踪工具。

关于跟踪议题中的 代码扫描 警报

代码扫描 警报与 GitHub Issues 中的任务列表集成,可让您轻松地在所有开发工作中确定警报的优先级并进行跟踪。 有关议题的更多信息,请参阅“关于议题”。

要跟踪议题中的代码扫描警报,请将警报的 URL 添加为议题中的任务列表项。 有关任务列表的更多信息,请参阅“关于任务列表”。

您还可以创建新议题来跟踪警报:

  • 从 代码扫描 警报创建,这会自动将代码扫描警报添加到新议题的任务列表中。 更多信息请参阅下面的“从 代码扫描 警报创建跟踪议题”。

  • 像往常一样通过 API 创建,然后在议题正文中提供代码扫描链接。 您必须使用任务列表语法来创建跟踪关系:

    • - [ ] <full-URL- to-the-code-scanning-alert>
    • 例如,如果将 - [ ] https://github.com/octocat-org/octocat-repo/security/code-scanning/17 添加到议题中,则该议题将跟踪在 octocat-org 组织中 octocat-repo 存储库的“Security(安全)”选项卡中 ID 号为 17 的代码扫描警报。

您可以使用多个议题来跟踪同一 代码扫描 警报,并且议题可属于找到 代码扫描 警报的存储库中的不同存储库。

GitHub 在用户界面的不同位置提供视觉提示,以指示何时跟踪议题中的 代码扫描 警报。

  • 代码扫描警报列表页将显示在议题中跟踪的警报,以便您可以一目了然地查看哪些警报仍需要处理。

    代码扫描警报页面上的跟踪片

  • “tracked in(跟踪)”部分也会显示在相应的警报页面中。

    代码扫描警报页面上的跟踪部分

  • 在跟踪议题上,GitHub 会在任务列表和悬停卡上显示安全徽章图标。

    只有对存储库具有写入权限的用户才能看到议题中警报的展开 URL 以及悬停卡片。 对于对存储库具有读取权限或根本没有权限的用户,警报将显示为纯 URL。

    图标的颜色为灰色,因为警报在每个分支上的状态为“打开”或“关闭”。 议题跟踪警报,因此警报在议题中不能具有单个打开/关闭状态。 如果一个分支上的警报已关闭,则图标颜色不变。

    跟踪议题中的悬停卡

如果更改议题中相应任务列表项的复选框状态(选中/未选中),则跟踪的警报状态不会更改。

从代码扫描警报创建跟踪议题

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

  2. 在仓库名称下,单击 Security(安全)Security 选项卡

  3. 在左侧边栏中,单击 Code scanning alerts(代码扫描警报)"Code scanning alerts(代码扫描警报)" 选项卡

  4. 在 "代码扫描" 下,单击要探索的警报。

  5. (可选)若要查找要跟踪的警报,可以使用自由文本搜索或下拉菜单来筛选和定位警报。 更多信息请参阅“管理仓库的代码扫描警报”。

  6. 在页面顶部的右侧,单击 Create issue(创建议题)

    为代码扫描警报创建跟踪议题

    GitHub 会自动创建一个议题来跟踪警报,并将警报添加为任务列表项。 GitHub 会预填议题:

    • 标题包含 代码扫描 警报的名称。
    • 正文包含任务列表项,其中包含 代码扫描 警报的完整 URL。
  7. (可选)编辑议题的标题和正文。

    警告: 您可能需要编辑议题的标题,因为它可能会暴露安全信息。 您还可以编辑议题的正文,但不要编辑任务列表项,否则议题将不再跟踪警报。

    代码扫描警报的新跟踪议题

  8. 单击 Submit new issue(提交新议题)