GitHub Actions
Usage
The Qodana Scan GitHub action allows you to run Qodana on a GitHub repository.
Basic configuration
To configure Qodana Scan, save the .github/workflows/code_quality.yml
file containing the workflow configuration:
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:
This sample invokes 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
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:
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 themain
branch.
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.
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:
Run Qodana locally over your project:
Open your report at
http://localhost:8080/
, add detected problems to the baseline, and download theqodana.sarif.json
file.Upload the
qodana.sarif.json
file to your project root folder on GitHub.Append
--baseline,qodana.sarif.json
argument to the Qodana Scan action configurationargs
parameter in thecode_quality.yml
file:
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:
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.
GitHub Pages
If you wish to study Qodana reports directly on GitHub, you can host them on your GitHub Pages repository using this example workflow:
Get a Qodana badge
You can set up a Qodana workflow badge in your repository. To do it, follow these steps:
Navigate to the workflow run that you previously configured.
On the workflow page, select Create status badge.
Copy the Markdown text to your repository README file.
![Creating status badge Creating status badge](https://user-images.githubusercontent.com/13538286/148529278-5d585f1d-adc4-4b22-9a20-769901566924.png)
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.
Use with
to define any action parameters:
Name | Description | Default Value |
---|---|---|
| Additional Qodana CLI | - |
| Directory to store the analysis results. Optional. |
|
| Upload Qodana results as an artifact to the job. Optional. |
|
| Specify Qodana results artifact name, used for results uploading. Optional. |
|
| Directory to store Qodana cache. Optional. |
|
| Utilize GitHub caches for Qodana runs. Optional. |
|
| Allows customizing the generated cache hash. Optional. |
|
| Use annotation to mark the results in the GitHub user interface. Optional. |
|
| Analyze only changed files in a pull request. Optional. |
|