Skip to main content
Skip to content

启用 GitHub Code Quality

启用Code Quality,为您的团队建立一致的质量基线:在拉取请求中以及默认分支上自动发现、修复并报告代码质量问题。

谁可以使用此功能?

具有 管理员 角色的存储库所有者、组织所有者和用户

GitHub Team 或 GitHub Enterprise Cloud

可以为单个存储库启用,也可以一次性为组织中的每个存储库启用 Code Quality 。 在组织级别启用可让所有团队获得一致的质量基线,只需进行一次更改,同时启用每个存储库即可让你以特定项目为目标或逐步推出。

先决条件

  • 企业所有者必须已在您的企业中启用 Code Quality。 请参阅“允许在您的企业中使用 GitHub Code Quality”。
  • GitHub Actions 必须启用,因为 Code Quality 使用操作来运行每个 CodeQL 分析。
  • 若要充分利用该功能,存储库应包含支持 CodeQL的质量分析语言之一。 请参阅 支持的语言。

为你的存储库启用 Code Quality

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

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

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏中的“安全性”下,单击 代码质量 以显示“代码质量”页。

  4. 单击“ 启用代码质量”。

  5. 查看“代码质量”页上的信息:

  6. 单击“ 保存更改 ”保存配置 Code Quality。

如果组织配置了专用注册表的缓存,这些注册表将可用于代码质量分析,以用于解析依赖项。 请参阅“授予安全功能访问专用注册表的权限”。

为你的组织启用 Code Quality

在组织级别,你可以通过单个Code Quality设置来控制****。 这为你提供了细粒度选项:从启用所有存储库,到针对特定列表或动态筛选条件,从而让你能够有计划地试点 Code Quality,并按自己的节奏逐步推广。 所选中的存储库处于启用状态,并且禁用所选内容之外的存储库。

有关可用访问选项以及筛选和强制实施的工作原理,请参阅 面向各类组织和企业的代码质量赋能。

  1. 在 GitHub 上,导航到组织的主页面。

  2. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  3. 在边栏中的“安全性”下,单击 代码质量。

  4. 在“存储库访问”下,从下拉菜单中选择一个选项。

    • 如果选择了 所选存储库...,请选择要启用的存储库。
    • 如果选择了 “匹配筛选器...”,请定义筛选器。
  5. (可选)若要防止存储库管理员更改这些设置,请启用 强制访问。

  6. 如果更改在任何存储库上启用或禁用 Code Quality ,将显示“查看启用和计费更改”对话框,其中显示了已启用和禁用的存储库总数以及关联的成本。 查看详细信息,然后单击“ 确认”。

更改会自动保存,并开始立即传播。 在大型组织中,更改可能需要几分钟才能在所有存储库中应用。

如果要跨多个团队推出该功能,我们建议在小组上进行试点,并在在任何地方启用之前优化质量阈值。 请参阅“大规模推出 GitHub Code Quality”。

启用后扫描频率

启用 Code Quality时,初始 CodeQL 扫描将在默认分支上运行。 每周计划的 CodeQL 扫描仅在推送或拉取请求触发扫描后启动。 启用前推送和拉取请求不算作活动。

如果过去 180 天内没有触发扫描,则每周计划的扫描将暂停。 初始扫描、配置或语言更改触发的扫描,计划的扫描不计为活动。 新的推送或拉取请求触发的扫描将恢复每周计划。