GitHub Actions

Basic configuration

To configure Qodana Scan, save the .github/workflows/code_quality.yml file containing the workflow configuration:

name: Qodana
on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main
      - 'releases/*'

jobs:
  qodana:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: 'Qodana Scan'
        uses: JetBrains/qodana-action@v2022.3.4

Using this workflow, Qodana will run on the main branch, release branches, and on the pull requests coming to your repository.

Note: fetch-depth: 0 is required for checkout in case Qodana works in pull request mode (reports issues that appeared only in that pull request).

We recommend that you have a separate workflow file for Qodana because different jobs run in parallel.

GitHub code scanning

You can set up GitHub code scanning for your project using Qodana. To do it, add these lines to the code_quality.yml workflow file right below the basic configuration of Qodana Scan:

- uses: github/codeql-action/upload-sarif@v2
  with:
    sarif_file: ${{ runner.temp }}/qodana/results/qodana.sarif.json

This sample invokes codeql-action for uploading a SARIF-formatted Qodana report to GitHub and specifies the report file using the sarif_file key.

tip

GitHub code scanning does not export inspection results to third-party tools, which means you cannot use this data for further processing by Qodana. In this case, you must set up baseline and quality gate processing on the Qodana side before submitting inspection results to GitHub code scanning. See the Quality gate and baseline section for details.

Pull request quality gate

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

1. Create a new or open an existing GitHub workflow that invokes the Qodana Scan action.

2. 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.

3. Set the number of problems (integer) for the Qodana action fail-threshold option.

4. Under your repository name, click Settings.

5. On the left menu, click Branches.

6. In the branch protection rules section, click Add rule.

7. Add main to Branch name pattern.

8. Select Require status checks to pass before merging.

9. Search for the Qodana status check, then check it.

10. Click Create.

Quality gate and baseline

You can combine the quality gate, and baseline features to manage your technical debt, report only new problems, and block pull requests that contain too many issues.

Follow these steps to establish a baseline for your project:

1. Run Qodana locally over your project:

cd <source-directory>
qodana scan --show-report

2. Open your report at http://localhost:8080/, add detected problems to the baseline, and download the qodana.sarif.json file.

3. Upload the qodana.sarif.json file to your project root folder on GitHub.

4. Append --baseline,qodana.sarif.json argument to the Qodana Scan action configuration args parameter in the code_quality.yml file:

- name: Qodana Scan
  uses: JetBrains/qodana-action@v2022.3.4
  with:
    args: --baseline,qodana.sarif.json

If you want to update the baseline, you must repeat these steps.

After that, the Qodana Scan GitHub action will generate alerts only for the problems that were not added to the baseline as new.

To establish a quality gate additionally to the baseline, add this line to qodana.yaml in the root of your repository:

failThreshold: <number-of-accepted-problems>

Based on this, you will be able to detect only new problems in pull requests that fall beyond the baseline. At the same time, pull requests with new problems exceeding the fail-threshold limit will be blocked, and the workflow will fail.

Qodana Cloud

To forward inspection results to Qodana Cloud, all you need to do is to specify the QODANA_TOKEN environment variable in the build configuration.

1. In the GitHub UI, create the QODANA_TOKEN encrypted secret and save the project token as its value.

2. In the GitHub workflow file, add QODANA_TOKEN variable to the env section of the Qodana Scan step:

- name: 'Qodana Scan'
  uses: JetBrains/qodana-action@v2022.3.4
  env:
     QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

After the token is set for analysis, all Qodana job results will be uploaded to your Qodana Cloud project.

Get a Qodana badge

You can set up a Qodana workflow badge in your repository. To do it, follow these steps:

1. Navigate to the workflow run that you previously configured.

2. On the workflow page, select Create status badge.

3. Copy the Markdown text to your repository README file.