注意
GitHub Code Quality 当前正处于 公共预览版 阶段，并可能会发生变化。 在 公共预览版期间，Code Quality 不会计费，尽管 Code Quality 扫描将使用 GitHub Actions 分钟。
介绍
可以通过将 “要求代码质量结果 ”分支规则添加到规则集并指定所需的严重性级别来阻止不符合代码质量标准的拉取请求。 如果拉取请求未达到此阈值，则无法合并请求。
先决条件
- Code Quality 已启用。 请参阅“启用 GitHub Code Quality”
- 支持的语言中的代码。 请参阅 支持的语言。
注意
仅当存储库具有一个或多个受支持语言的代码时，阈值才会产生影响，请参阅 启用 GitHub Code Quality。
确认 Code Quality 在拉取请求上成功运行
在添加或更新规则集以包含 Code Quality 的阈值之前，请确认 代码质量 工作流正在运行并向拉取请求返回结果。 否则，规则集可能会阻止所有拉取请求的合并。
- 打开最近的拉取请求，滚动到拉取请求底部的“检查”摘要。
- 确认“CodeQL - 代码质量”检查已成功运行并报告其状态。
有关详细信息，请参阅“基于 CodeQL 的代码质量分析”。
添加或更新规则集以包含 Code Quality
- 导航到存储库的“设置”选项卡。
- 在左侧边栏的“代码和自动化”下，展开 规则，然后单击“规则集”****。
- 如果还没有用于保护默认分支的规则集，请展开 “新建规则集 ”，然后单击“ 新建分支规则集”。 或者，打开默认分支的现有规则集并移动到步骤 5。
- 如果要创建新的规则集：
- 定义规则集的名称。
- 将“强制状态”设置为“活动”。
- 在“目标分支”下，添加“包括默认分支”的目标。
- 在“分支规则”下，启用“要求代码质量结果”。
- 设置“严重级别”以定义拉取请求合并到默认分支之前必须解决的代码质量结果的最低严重级别。 例如：
- 将“错误”设置为阻止含有未解决代码质量错误的拉取请求合并。
- 设置“警告及以上”以阻止包含未解决的代码质量警告或错误的拉取请求合并。
- 设置“注释和更高”以阻止未解析的代码质量注释、警告或错误的拉取请求被合并。
- 设置“All”以阻止包含任何未解决的代码质量问题的拉取请求被合并。
- 完成定义或编辑规则集后，单击“ 创建 ”或“ 保存更改”。
后续步骤
了解 GitHub Code Quality 如何在拉取请求上工作，以防止代码质量问题进入默认分支。 请参阅“在合并拉取请求之前修复代码质量问题”。