Skip to content

Commit 636ac30

Browse files
committed
Doc: test & Qodana
1 parent 341073a commit 636ac30

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

.github/readme/qodana.png

96.6 KB
Loading

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,26 @@ The project-specific configuration file [gradle.properties][file:gradle.properti
7979
| `gradleVersion` | Version of Gradle used for plugin development. |
8080

8181
The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details.
82+
83+
### Testing
84+
85+
No functional or UI tests are available yet.
86+
87+
### Code Monitoring
88+
89+
Code quality is monitored with the help of [Qodana](https://www.jetbrains.com/qodana/)
90+
91+
Qodana inspections are accessible within the project on two levels:
92+
93+
- using the [Qodana IntelliJ GitHub Action][docs:qodana-github-action], run automatically within the [Build](.github/workflows/build.yml) workflow,
94+
- with the [Gradle Qodana Plugin][gh:gradle-qodana-plugin], so you can use it on the local environment or any CI other than GitHub Actions.
95+
96+
Qodana inspection is configured with the `qodana { ... }` section in the [Gradle build file][file:build.gradle.kts] and [`qodana.yml`][file:qodana.yml] YAML configuration file.
97+
98+
> **NOTE:** Qodana requires Docker to be installed and available in your environment.
99+
100+
To run inspections, you can use a predefined *Run Qodana* configuration, which will provide a full report on `http://localhost:8080`, or invoke the Gradle task directly with the `./gradlew runInspections` command.
101+
102+
A final report is available in the `./build/reports/inspections/` directory.
103+
104+
![Qodana][file:qodana.png]

0 commit comments

Comments
 (0)