注意
GitHub 代码质量目前处于公开预览阶段,可能会有变更。在公开预览期间,代码质量不会产生费用,但代码质量扫描会消耗 GitHub Actions 分钟数。
概览
GitHub 代码质量帮助您确保代码库可靠、可维护且高效。无论是构建新功能、降低技术债务,还是报告仓库健康状况,代码质量都提供可操作的洞察和自动修复,让您能够高效地改善和维护仓库的代码健康。
关键功能和优势
使用代码质量,您可以
- 在拉取请求和通过仓库扫描中识别代码质量风险和改进机会。
- 查看对发现问题的明确解释,并应用一键Copilot 驱动的自动修复。
- 使用仓库仪表盘跟踪可靠性和可维护性评分,识别需要关注的区域,并优先安排修复工作。
- 监控组织仪表盘,一目了然地了解仓库的代码健康状态,并确定需要进一步调查的仓库。
- 为拉取请求设置规则集,以强制执行代码质量标准并阻止不符合您标准的更改。
- 如果您拥有 Copilot 许可,可轻松将修复工作分配给Copilot 云代理。
可用性和使用费用
GitHub 代码质量在 GitHub Team 和 GitHub Enterprise Cloud 计划中对组织拥有的仓库可用。
在公开预览期间,GitHub 代码质量不会产生费用。但代码质量扫描会消耗 GitHub Actions 分钟。请参阅 GitHub 代码质量计费。
注意
- 您无需Copilot 或代码安全许可即可使用代码质量或应用 Copilot 驱动的自动修复。
支持的语言
代码质量使用 CodeQL 对以下语言执行基于规则的分析
- C#
- Go
- Java
- JavaScript
- Python
- Ruby
- TypeScript
代码质量还会执行 AI 驱动的分析,结果会在“AI 发现”仓库仪表盘中单独显示。与扫描整个代码库和拉取请求的基于规则的 CodeQL 分析不同,AI 驱动的分析仅检查最近推送到默认分支的文件,并可能识别出超出上述语言范围的问题。更多信息,请参阅 GitHub 代码质量的负责任使用。
发现结果将显示在哪里?
启用仓库的代码质量后,您将看到针对以下内容的 CodeQL 扫描:
- 针对默认分支打开的每个新拉取请求
- 默认分支的所有现有拉取请求在更新时会触发新的 CI 测试运行
- 在“代码质量”设置页面显示的时间点,默认分支上的整个代码库
此外,您还会看到对默认分支所有最近推送的 AI 驱动分析。
拉取请求结果
当 CodeQL 在拉取请求中发现基于规则的问题时,您会看到来自 github-code-quality[bot] 的评论。尽可能地,每条评论都会包含一个 Copilot 自动修复建议,说明如何解决该问题。请参阅 在合并拉取请求前修复代码质量发现。
默认分支结果
默认分支上的代码质量发现会在仓库的 “代码质量” 页面上,通过 安全与质量 选项卡报告
- 标准发现显示 CodeQL 质量分析的结果。请参阅 改进仓库代码质量。
- AI 发现显示对最近推送到默认分支的文件进行的 AI 驱动分析结果。请参阅 使用 AI 改进最近合并代码的质量。
扫描信息
每次 CodeQL 分析都会消耗 GitHub Actions 分钟,可在仓库的 Actions 选项卡中看到作为动态 “代码质量” 工作流的运行。
后续步骤
- 针对您的仓库:打开代码质量以开始生成结果。请参阅 启用 GitHub 代码质量。
- 针对您的企业:确保企业内的仓库能够启用代码质量。请参阅 在企业中允许使用 GitHub 代码质量。