Skip to main content

启用 GitHub Code Quality

使用 Code Quality 自动在 Pull request 和默认分支中捕获、修复和报告代码质量问题。

谁可以使用此功能?

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

GitHub Team 或 GitHub Enterprise Cloud

在本文中

数据可复用.code-quality.code-quality-preview-note %}

先决条件

  • 必须启用 GitHub Actions,因为 Code Quality 会使用操作来运行每次 CodeQL 分析。
  • 要充分利用此功能,你的存储库应包含 CodeQL 支持进行质量分析的其中一种语言。 请参阅 支持的语言

为存储库启用 Code Quality

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

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

  2. 在边栏的“安全性”下,单击 数据变量.code-quality.code_quality_ui_settings %} 以显示“数据变量.code-quality.code_quality_ui %}”页面。

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

    注意

    如果在此视图中缺少 “启用代码质量”,则可能是因为企业所有者已禁用您所在组织对 数据变量.product.prodname_code_quality_short %} 的使用。 请参阅“允许在企业中使用 GitHub Code Quality。”。

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

    •      **语言:** 如果要为任何语言禁用 CodeQL 分析,请清除相应的复选框。
      
    •      **运行程序类型:** 如果要使用不同的 **运行程序,请选择“已标记的运行程序** ”并定义 **运行器标签**。 请参阅“[AUTOTITLE](/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners)”和“[AUTOTITLE](/actions/how-tos/manage-runners/self-hosted-runners/apply-labels)”。
      
  5. 单击“保存更改”**** 以保存 Code Quality 的配置。

提示

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

后续步骤

  •         **对于你的存储库:** 浏览代码质量检测结果并合并你的第一个修复。 请参阅“[AUTOTITLE](/code-security/tutorials/improve-code-quality/quickstart)”。
    
  •         **对于组织:** 一目了然地了解存储库的代码运行状况。 请参阅“[AUTOTITLE](/code-security/how-tos/view-and-interpret-data/analyze-organization-data/explore-code-quality)”。