注意
GitHub Code Quality 当前正处于 公开预览 阶段,并可能会发生变化。 在 公开预览期间,Code Quality 不会计费,尽管 Code Quality 扫描将使用 GitHub Actions 分钟。
概述
GitHub Code Quality 有助于确保代码库可靠、可维护且高效。 无论是构建新功能、减少技术债务还是报告存储库运行状况, Code Quality 都可以提供可操作的见解和自动修复,以便可以有效地改进和维护存储库的代码运行状况。
主要功能和优势
通过 Code Quality,您可以:
- 确定 拉取请求 和 存储库扫描中的代码质量风险和机会。
- 查看结果的清晰说明,并应用一键式 Copilot 自动修复。
- 使用 存储库仪表板 跟踪可靠性和可维护性分数,确定需要注意的领域,并确定修正的优先级。
- 监视 组织仪表板 ,以便一目了然地了解存储库的代码运行状况,并确定要进一步调查的存储库。
- 为拉取请求设置 规则集 ,以强制实施代码质量标准,并阻止不符合条件的更改。
- 如果拥有Copilot云代理许可证,可以轻松将修正工作分配给****。
可用性和使用成本
GitHub Code Quality 适用于 GitHub Team 上组织拥有的存储库和 GitHub Enterprise Cloud 计划。
GitHub Code Quality 不会在公共预览版期间计费。 但是,Code Quality 扫描将消耗 GitHub Actions 分钟。 请参阅“GitHub Code Quality 计费”。
注意
- 无需 Copilot 或 Code Security 许可证,即可使用 Code Quality 或应用 Copilot 自动修复。
支持的语言
Code Quality 使用以下 CodeQL语言执行基于规则的分析:
- C#
- Go
- Java
- JavaScript
- Python
- Ruby
- TypeScript
Code Quality 还执行 AI 驱动的分析,结果在“AI 发现”存储库仪表板上单独显示。 与扫描整个代码库和拉取请求的基于 CodeQL 规则的分析不同,这种由 AI 驱动的分析仅检查最近推送到默认分支的文件,并可能识别上述语言以外的语言问题。 有关详细信息,请参阅“负责任地使用 GitHub 代码质量工具”。
结果会在哪里出现?
为存储库启用 Code Quality 后,你将看到 CodeQL 扫描:
- 针对默认分支打开的每个新拉取请求
- 默认分支的所有现有拉取请求在更新时(触发 CI 测试新运行)
- “代码质量”设置页上显示的日期和时间,默认分支上的整个代码库
此外,你还将看到对所有最近推送到默认分支的代码的 AI 驱动分析结果。
拉取请求结果
当CodeQL在拉取请求中发现基于规则的问题时,您将看到github-code-quality[bot]的注释。 如果可能,每个注释都将包含 Copilot自动修复 有关如何解决问题的建议。 请参阅“在合并拉取请求之前修复代码质量问题”。
默认分支结果
Code Quality 默认分支上的结果会在存储库 Security and quality 选项卡的“代码质量”页上报告:
-
** 常规发现 ** 显示 CodeQL 质量分析结果。 请参阅“[AUTOTITLE](/code-security/code-quality/tutorials/improve-your-codebase)”。 -
** AI 发现 ** 显示对最近推送到默认分支的文件的 AI 分析结果。 请参阅“[AUTOTITLE](/code-security/code-quality/tutorials/improve-recent-merges)”。
扫描信息
每次 CodeQL 分析将使用 GitHub Actions 分钟,可在存储库的“操作”**** 选项卡上作为动态“代码质量”工作流的运行查看。
后续步骤
- 对于存储库: 打开Code Quality功能,以开始生成结果。 请参阅“启用 GitHub Code Quality”。
- 对于企业: 确保企业中的存储库可以启用 Code Quality。 请参阅“允许在企业中使用 GitHub Code Quality。”。