GitHub Actions

Prepare your project

Basic configuration

On the Settings tab of the GitHub UI, create the QODANA_TOKEN encrypted secret and save the project token as its value. If you are using a Qodana Cloud instance other than https://qodana.cloud/, override it by declaring the QODANA_ENDPOINT environment variable.
On the Actions tab of the GitHub UI, set up a new workflow and create the .github/workflows/code_quality.yml file.

To inspect the main and master branches, as well as release branches and the pull requests coming to your repository, save this workflow configuration to the .github/workflows/code_quality.yml file:

name: Qodana
on:
  workflow_dispatch:
  pull_request:
  push:
    branches: # Specify your branches here
      - main # The 'main' branch
      - master # The 'master' branch
      - 'releases/*' # The release branches

jobs:
  qodana:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
      checks: write
    steps:
      - uses: actions/checkout@v3
        with:
          ref: ${{ github.event.pull_request.head.sha }}  # to check out the actual pull request commit, not the merge commit
          fetch-depth: 0  # a full history is required for pull request analysis
      - name: 'Qodana Scan'
        uses: JetBrains/qodana-action@v2024.3
        env:
          QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

Quick-fixes

Choose the quick-fix strategy using either of two configuration methods:

qodana.yaml

Workflow configuration

# Possible values: apply | cleanup
fixesStrategy: apply

Depending on your needs, configure the push-fixes option of your workflow configuration:
Pull request
Original branch
Save this configuration to create a new branch with fixes and a pull request to the original branch:
push-fixes: pull-request
Also, enable GitHub Actions to create and approve pull requests.
Save this configuration to push fixes to the original branch:
push-fixes: branch pr-mode: false

Set the correct permissions for the job, for example:

permissions:
  contents: write
  pull-requests: write
  checks: write

permissions:
  contents: write
  pull-requests: write
  checks: write
steps:
  - name: 'Qodana Scan'
    uses: JetBrains/qodana-action@v2024.3
    with:
      args: --apply-fixes
      push-fixes: pull-request
    env:
      QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

GitHub code scanning

You can set up GitHub code scanning for your project using Qodana. To do this, 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 the codeql-action for uploading a SARIF-formatted Qodana report to GitHub, and specifies the report file using the sarif_file key.

Pull request quality gate

Create a new or open an existing GitHub 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 number of problems (integer) 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.

Baseline and quality gate

Baseline

Run Qodana locally on your project:

cd project
qodana scan \
  -e QODANA_TOKEN="<cloud-project-token>"

In Qodana Cloud, add detected problems to the baseline and then download the qodana.sarif.json file.
Upload the qodana.sarif.json file to your project root on GitHub.
Append the --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@main
  with:
    args: --baseline,qodana.sarif.json
```

Quality gate

To establish a quality gate, in the workflow configuration specify the --fail-threshold option:

- name: Qodana Scan
  uses: JetBrains/qodana-action@v2024.3
  with:
    args: --fail-threshold,<number-of-accepted-problems>
  env:
    QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

Combined configuration

- name: Qodana Scan
  uses: JetBrains/qodana-action@v2024.3
  with:
    args: --baseline,qodana.sarif.json,--fail-threshold,<number-of-accepted-problems>
  env:
    QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

At the same time, pull requests with new problems exceeding the --fail-threshold limit will be blocked, and the workflow will fail.

Configuration

Most likely, you won't need other options than args: all other options can be helpful if you are configuring multiple Qodana Scan jobs in one workflow.

with:
  args: --baseline,qodana.sarif.json
  cache-default-branch-only: true

Name	Description	Default Value
`args`	Additional Qodana CLI `scan` command arguments, split the arguments with commas (`,`), for example `-i,frontend,--print-problems`. Optional.	-
`results-dir`	Directory to store the analysis results. Optional.	`${{ runner.temp }}/qodana/results`
`upload-result`	Upload Qodana results (SARIF, other artifacts, logs) as an artifact to the job. Optional.	`false`
`artifact-name`	Specify Qodana results artifact name, used for results uploading. Optional.	`qodana-report`
`cache-dir`	Directory to store Qodana cache. Optional.	`${{ runner.temp }}/qodana/caches`
`use-caches`	Utilize GitHub caches for Qodana runs. Optional.	`true`
`primary-cache-key`	Set the primary cache key. Optional.	`qodana-2024.3-${{ github.ref }}-${{ github.sha }}`
`additional-cache-key`	Set the additional cache key. Optional.	`qodana-2024.3-${{ github.ref }}`
`cache-default-branch-only`	Upload cache for the default branch only. Optional.	`false`
`use-annotations`	Use annotation to mark the results in the GitHub user interface. Optional.	`true`
`pr-mode`	Analyze ONLY changed files in a pull request. Optional.	`true`
`post-pr-comment`	Post a comment with the Qodana results summary to the pull request. Optional.	`true`
`github-token`	GitHub token to access the repository: post annotations, comments. Optional.	`${{ github.token }}`
`push-fixes`	Push Qodana fixes to the repository, can be `none`, `branch` to the current branch, or `pull-request`. Optional.	`none`

GitHub Actions﻿

Prepare your project﻿

Qodana Cloud﻿

Basic configuration﻿

note

Quick-fixes﻿

tip

GitHub code scanning﻿

tip

Pull request quality gate﻿

Baseline and quality gate﻿

Baseline﻿

Quality gate﻿

Combined configuration﻿

Get a Qodana badge﻿

Configuration﻿