Inspection profiles
Inspection profiles define inspections, the file scopes that these inspections analyze, and inspection severities. This section explains how you can use existing Qodana profiles, create your own profiles, and set up profiles for analyzing your projects using Qodana.
Out of the box, you can use the following Qodana profiles:
Profile name | Description |
|---|---|
| The subset of the |
| Implements default profiles of JetBrains IDEs like IntelliJ IDEA with the following exceptions:
|
| This profile is enabled by default to analyze whether a project is configured properly. If To learn how disable inspections of this profile, see the Disable sanity checks and Profile sections. |
All profiles are hosted on GitHub, so you can learn them in detail.
To learn how to set up existing Qodana profiles, see the Set up a profile section.
You can create custom profiles using the following formats:
Custom profiles can either override existing profiles or be created from scratch. Since profile configurations should be contained in dedicated files, we recommend saving them in the .qodana directory of your project.
For example, to use the existing qodana.recommended profile and additionally enable the Java/Java language level migration aids inspection category, save this YAML configuration in the profile file:
name: "Configuring Qodana"
baseProfile: qodana.recommended
inspections:
- group: "category:Java/Java language level migration aids" # Specify the inspection category
enabled: true # Enable the inspection categorytip
A detailed reference guide is available in the Custom YAML profiles section.
After you create your own profile, save the file in the .qodana directory of your project so that Qodana can ignore this file during code analysis.
note
If you run Qodana in a CI/CD pipeline, make sure the file containing the profile resides in the working directory where the VCS stores your project before building it.
To learn how to set up a custom profile, see the Set up a profile section.
note
You can disable the
qodana.sanityprofile using recommendations from the Disable sanity checks and Profile sections.
A YAML file serves as a universal Qodana configuration. This means that you can configure Qodana using the qodana.yaml file once and then reuse it for running Qodana with Docker, GitHub, JetBrains IDEs or any other software currently supported by Qodana. The settings will remain consistent across all these platforms.
To set up the qodana.recommended profile, in the project root save the qodana.yaml file containing the following configuration:
profile:
name: qodana.recommendedTo set up your custom profile, in the qodana.yaml file save this configuration containing the relative path to the profile file, for example:
profile:
path: .qodana/<custom-profile.yaml>In your IDE, navigate to Tools | Qodana | Try Code Analysis with Qodana.
On the
profilesection of the Run Qodana dialog, paste the profile configuration:Qodana profileCustom profileprofile: name: qodana.recommendedThis is an example of how the result will look:
profile: path: .qodana/<custom-profile.yaml>This is an example of how the result will look:
On the Run Qodana dialog, check the Save qodana.yaml in project root option.
Click Run to start analyzing your code.
note
Running Qodana using GitHub requires a project token.
On the Settings tab of the GitHub UI, create the
QODANA_TOKENencrypted secret and save the project token as its value.On the Actions tab of the GitHub UI, set up a new workflow and create the
.github/workflows/code_quality.ymlfile.To inspect the
mainbranch, release branches and the pull requests coming to your repository, save the workflow configuration to the.github/workflows/code_quality.ymlfile:Qodana profileCustom profilename: Qodana on: workflow_dispatch: pull_request: push: branches: # Specify your branches here - main # The 'main' 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.1 with: args: --profile-name,qodana.recommended env: QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}Here, the
--profile-nameoption specifies theqodana.recommendedprofile.name: Qodana on: workflow_dispatch: pull_request: push: branches: # Specify your branches here - main # The 'main' 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.1 with: args: --profile-path,.qodana/<custom-profile.yaml> env: QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}Here, the
--profile-pathoption specifies the relative path to the file containing a custom profile.
note
Running Qodana using GitHub requires a project token.
You can set up the qodana.recommended profile using the --profile-name option:
$docker run \ -v $(pwd):/data/project/ \ -e QODANA_TOKEN="<cloud-project-token>" \ jetbrains/qodana-<linter> \ --profile-name qodana.recommended
$qodana scan \ -e QODANA_TOKEN="<cloud-project-token>" \ --profile-name qodana.recommended
You can set up your custom profile using the --profile-path option:
$docker run \ -v $(pwd):/data/project/ \ -v $(pwd)/.qodana/<custom-profile.yaml>:/data/project/myprofiles/<custom-profile.yaml> \ -e QODANA_TOKEN="<cloud-project-token>" \ jetbrains/qodana-<linter> \ --profile-path /data/project/myprofiles/<custom-profile.yaml>
$qodana scan \ -v .qodana/<custom-profile.yaml>:/data/project/myprofiles/<custom-profile.yaml> \ -e QODANA_TOKEN="<cloud-project-token>" \ --profile-path .qodana/<custom-profile.yaml>
Thanks for your feedback!