Setting code quality thresholds for pull requests

Create a Code Quality gate for pull requests to increase the quality of code merged into your repository.

Qui peut utiliser cette fonctionnalité ?

Repository owners, organization owners, security managers, and users with the admin role

GitHub Code Quality is available for:

  • Public repositories on GitHub.com
  • Organization-owned repositories on GitHub Team or GitHub Enterprise Cloud

Dans cet article

Remarque

GitHub Code Quality is currently in public preview and subject to change. During public preview, Code Quality will not be billed, although Code Quality scans will consume GitHub Actions minutes.

Introduction

You can block pull requests that don't meet your code quality standards by adding the Require code quality results branch rule to a ruleset and specifying the severity level you require. If a pull request doesn't reach this threshold, it can't be merged.

Prerequisites

Remarque

The threshold will have an impact only if the repository has code in one or more of the supported languages, see Enabling GitHub Code Quality.

Confirming Code Quality runs successfully on pull requests

Before you add or update a ruleset to include a threshold for Code Quality, confirm that the Code Quality workflow is running and reporting results back to pull requests. Otherwise, the ruleset could block the merging of all pull requests.

  1. Open a recent pull request and scroll to the "Checks" summary at the bottom of the pull request.
  2. Confirm that the "CodeQL - Code Quality" check ran successfully and reported its status.

For more information, see CodeQL detection of code quality problems.

Adding or updating a ruleset to include Code Quality

  1. Navigate to the "Settings" tab of your repository.
  2. In the left sidebar, under "Code and automation", expand Rules, then click Rulesets.
  3. If you don't already have a ruleset to protect your default branch, expand New ruleset and click New branch ruleset. Alternatively, open your existing ruleset for the default branch and move to step 5.
  4. If you are creating a new ruleset:
    • Define a name for the ruleset.
    • Set the "Enforcement status" to "Active."
    • Under "Target branches" add a target of "Include default branch."
  5. Under "Branch rules", enable "Require code quality results".
  6. Set "Severity" to define the lowest severity of code quality results that must be resolved before a pull request can be merged into the default branch. For example:
    • Set "Errors" to block pull requests with unresolved code quality errors being merged.
    • Set "Warnings and higher" to block pull requests with unresolved code quality warnings or errors being merged.
    • Set "Notes and higher" to block pull requests with unresolved code quality notes, warnings or errors being merged.
    • Set "All" to block pull requests with any unresolved code quality results being merged.
  7. When you have finished defining or editing the ruleset, click Create or Save changes.

Next steps

Learn how GitHub Code Quality works on pull requests to prevent code quality issues from reaching your default branch. See Fixing code quality findings before merging your pull request.