CircleCI
Edit page Last modified: 21 November 2022CircleCI is a cloud-based CI/CD system. You can build Qodana into your CircleCI pipelines using the CircleCI Qodana orb as described in this procedure:
Create the
.circleci/config.yml
file and specify the CircleCI version:
version: 2.1
Below the CircleCI version, add the
orbs
stanza, and then specify theqodana
element along with the Qodana version:
orbs:
qodana: jetbrains/qodana@2022.2.2
If necessary, repeat this step for all required workflows and jobs.
In the CircleCI UI, opt in to use uncertified orbs.
tip
To learn more, visit the CircleCI Qodana orb page on the CircleCI developer portal.
Examples
Using this configuration sample, you can scan your project with Qodana with the default configuration parameters:
version: '2.1'
orbs:
qodana: jetbrains/qodana@2022.2.2
jobs:
code-quality:
machine:
image: 'ubuntu-2004:current'
steps:
- checkout
- qodana/scan
workflows:
main:
jobs:
- code-quality:
context: qodana
This configuration sample invokes the args
parameter to run the specific linter like jetbrains/qodana-jvm
:
version: 2.1
orbs:
qodana: jetbrains/qodana@2022.2.2
jobs:
code-quality:
machine:
image: 'ubuntu-2004:current'
steps:
- checkout
- qodana/scan:
args: -l jetbrains/qodana-jvm # use space to separate arguments
workflows:
main:
jobs:
- code-quality:
context: qodana
Commands and parameters
The CircleCI Qodana orb provides the scan
command to let you inspect your project and report the results.
This table contains the list of optional string parameters that can be additionally used with the scan
command.
Parameter | Description | Default value |
---|---|---|
| Customize the generated cache hash |
|
| Additional arguments of the Qodana CLI | No default value |
| Name of the artifact resulting from scanning project with Qodana, used for uploading of scan results |
|
| Directory for Qodana caches |
|
| Directory for storing the results of scanning |
|