探索组织中的 GitHub 代码质量结果

使用组织级 Code Quality 仪表板来发现需要注意的存储库并一目了然地跟踪组织的代码运行状况。

谁可以使用此功能？

Organization members

GitHub Team 或 GitHub Enterprise Cloud

Phase 4: Assess the pilot and decide

4 篇中的第 1 篇
下一步:解读存储库的代码质量评估结果

在本文中

先决条件

查看组织的代码质量见解

组织级仪表板有两个选项卡：

  • “ 运行状况 ”选项卡显示组织的当前代码运行状况的快照。
  • “ 趋势 ”选项卡显示打开的发现在所选时间段内如何更改，以便跟踪进度并确定需要注意的存储库。
  1. 在 GitHub 上，导航到您的组织主页。 例如，从 https://github.com/settings/organizations。
  2. 在组织名称下，单击 Security and quality 该选项卡。
  3. 在边栏的“见解”部分中，单击 代码质量。

注意

仪表板上看到的内容取决于访问权限：

  • 组织所有者可以查看已启用 **** 的Code Quality存储库的数据。
  • 所有其他组织成员仅查看他们可以在其中查看 Code Quality 调查结果（存储库级别页面）的存储库的数据，最多可以查看 3,000 个存储库的数据。

筛选仪表板数据

仪表板顶部的筛选栏适用于运行状况和趋势两个选项卡。 您可以按以下条件进行筛选：

  • 可靠性分数
  • 可维护性分数
  • 常规发现
  • AI 发现
  • Topic
  • 团队
  • Visibility
  • 为组织定义的任何自定义属性

还可以在同一筛选栏中使用 “排序” 控件对仪表板数据进行排序。

查看当前代码运行状况

“ 运行状况 ”选项卡显示组织的代码运行状况快照。

解释分数分布图

分数分布图提供组织的代码运行状况的直观概述。 每个气泡表示具有相同可维护性和可靠性分数的存储库集合。

  • 每个气泡 的位置 演示了这些存储库的总体运行状况。 较高的气泡表示更高的可维护性分数，而右侧的气泡则表示更高的可靠性分数。
  • 气泡的颜色和边框模式指示这些存储库的低评分的严重程度。 例如，在任一类别中具有“差”分数的气泡将始终是红色，带有虚线边框。
  • 每个气泡 的大小 表示具有该特定分数组合的存储库数。

若要查看特定气泡表示的可维护性分数、可靠性分数和存储库数，请将鼠标悬停在气泡上。

浏览存储库表

气泡图下方有一个表列出了组织中的所有存储库。 在这里，可以查看代码质量结果，以及有关这些发现的详细信息。

可以通过单击列标题，按任意列的升序或降序对存储库表进行排序。

调查低评分存储库

  1. 若要筛选性能最低的存储库的仪表板数据，请在分数分布图上单击具有最低组合分数的气泡。
  2. 向下滚动到存储库表。 默认情况下，表从最不最新的存储库扫描排序，帮助你确定当前质量问题的优先级。
  3. （可选）若要确定发现次数最多的存储库的 CodeQL 优先级，请单击 常规发现 两次。
  4. 若要查看特定存储库的存储库级别仪表板，请单击存储库的名称。

“ 趋势 ”选项卡显示你有权访问的存储库中的打开结果以及与当前筛选器匹配的结果随时间推移而变化，以便你可以判断代码质量工作是否具有效果，以及下一步将注意力集中在何处。

  1. 在组织级仪表板上，单击“ 趋势 ”选项卡。
  2. 使用 “时间段 ”下拉列表选择时间范围：过去 7 天、14 天或 30 天。
  3. 查看“随时间推移的打开结果”图，该图显示所选时间段内在适用存储库中打开的发现总数。
  4. （可选）使用图形上方的按钮按 运行状况分数 或 严重性对数据进行分组。
  5. 将鼠标悬停在图表上的某个点上，即可查看当天的开放发现项数量。

解释图形时，请记住以下几点：

  • 该图基于开放结果的每日快照。 如果未在给定的某一天运行任何分析，则当天可能没有数据点。

  • 历史数据仅在开始拍摄快照时 Code Quality 可用，因此可能最初限制可用时间范围。

  • 该图表跟踪未解决发现项的总数，而不是正在打开或已修复的单个发现项。 计数的更改不一定意味着开发人员修复或引入了问题。

  • 在其他存储库上启用 Code Quality 可能会增加图表中显示的发现结果数量。 启用新存储库后增加并不一定意味着代码质量正在下降。

  • 该图跟踪当前正在筛选的存储库的打开结果总数。 总计数包括：

    • 代码更改或在新存储库上启用代码质量分析时引入的新发现
    • 在代码中已修复或由用户忽略的发现项

识别需要注意的存储库

在趋势图下方，两个表可帮助你确定所选时间段内哪些存储库需要注意：

  • 大多数改进的存储库 列出了在所选时间段内打开的发现量最大减少的存储库。
  • 需要改进的存储库 列出了所选时间段内开放发现量最大的存储库。

这两个表包含以下列：

  • 存储库：存储库的名称。
  • 总打开次数：所选时间段结束时存储库的打开结果数。
  • 净更改：在所选时间段内，存储库的打开查找计数是如何变化的。
  • 已忽略：所选时间段内该代码库中有多少项发现被忽略。

存储库的发现项数量受已修复和已忽略的发现项影响。 可以使用存储库级仪表板来确认更改的内容。

若要调查存储库，请单击其名称以打开其存储库级 Code Quality 仪表板，可在其中查看各个发现并采取修正措施。

后续步骤

若要了解存储库级仪表板上可用的代码运行状况信息，请参阅 解读存储库的代码质量评估结果。

如果计划跨多个存储库启用 Code Quality ，请参阅 大规模推出 GitHub Code Quality。