Quality gate

Quality gate is the maximum number of problems that can be detected by Qodana without causing a CI/CD workflow or pipeline fail. Once the quality gate limit is reached, Qodana terminates with the exit code 255.

This feature lets you control your code quality and build software that meets your quality metrics. For example, if you set the quality gate for ten problems, a build workflow will fail once the eleventh problem is detected.

The quality gate and fail threshold terms are used interchangeably with the former being a feature in overall, and the latter meaning a configuration option.

This section explains how to configure Qodana quality gate for:

Local run using a Docker command
GitHub actions
Jenkins
Gitlab CI/CD

Local run

You can run Qodana with the configured quality gate locally using available Docker images:

            docker run \
            -v <source-directory>/:/data/project/  \
            jetbrains/qodana-<linter> \
            --fail-threshold <number>
        

In this command, <source-directory> is the full local path to the project source code, and the --fail-threshold <number> option configures the quality gate.

GitHub Actions

You can enforce GitHub to block merge of pull requests if the Qodana quality gate has failed. To do it, create a branch protection rule as described below:

Create a new or open an existing GitHub Actions workflow that invokes the Qodana scan action.
Set the workflow to run on pull_request events that target the main branch.
on: pull_request: branches: - main
Instead of main, you can specify your branch here.
Set the fail threshold (number) for the Qodana Action fail-threshold option.
Under your repository name, click Settings.
On the left menu, click Branches.
In the branch protection rules section, click Add rule.
Add main to Branch name pattern.
Select Require status checks to pass before merging.
Search for the Qodana status check, then check it.
Click Create.

Jenkins

To set up Qodana quality gate in a Jenkins Pipeline, you can add the --fail-threshold <number> option to the steps block:

            pipeline {
               agent {
                  docker {
                     args '''
                        -v <path-to-project>:/data/project
                        --entrypoint=""
                     '''
                     image 'jetbrains/qodana-<linter>'
                  }
               }
               stages {
                  stage('Qodana') {
                     steps {
                        sh '''
                           qodana \
                           --fail-threshold <number>
                        '''
                     }
                  }
               }
            }
        

GitLab CI

To run Qodana quality gate in a GitLab CI/CD pipeline, you can save this configuration to the .gitlab-ci.yml file:

            qodana:
             image:
               name: jetbrains/qodana-<linter>
               entrypoint: ['']
             script:
               - qodana --fail-threshold <number>
             artifacts:
               paths:
                 - qodana
        

In this sample, the script section specifies the --fail-threshold <number> option.

Last modified: 18 January 2023