diff --git a/README.md b/README.md index 99546bde39..1fae9dcf52 100644 --- a/README.md +++ b/README.md @@ -166,17 +166,22 @@ diktat { Also `diktat` extension has different reporters. You can specify `json`, `html`, `sarif`, `plain` (default) or your own custom reporter (it should be added as a dependency into `diktat` configuration): ```kotlin diktat { - reporter = "json" // "html", "json", "plain" (default), "sarif" + // since 1.1.0 to keep in line with maven properties + reporter = "json" // "html", "json", "plain" (default), "sarif" + // before 1.1.0 + // reporterType = "json" // "html", "json", "plain" (default), "sarif" } ``` -You can also specify an output. +You can also specify an output. ```kotlin diktat { + // since 1.1.0 (reporterType for old versions) reporter = "json" output = "someFile.json" } ``` + You can run diktat checks using task `diktatCheck` and automatically fix errors with tasks `diktatFix`. @@ -250,7 +255,7 @@ Diktat can be run via spotless-maven-plugin since version 2.8.0 ## GitHub Native Integration -We suggest everyone to use common ["sarif"](https://docs.oasis-open.org/sarif/sarif/v2.0/sarif-v2.0.html) format as a `reporter` in CI/CD. +We suggest everyone to use common ["sarif"](https://docs.oasis-open.org/sarif/sarif/v2.0/sarif-v2.0.html) format as a `reporter` (`reporterType`) in CI/CD. GitHub has an [integration](https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning) with SARIF format and provides you a native reporting of diktat issues in Pull Requests. diff --git a/pom.xml b/pom.xml index 0e86a2062e..1ce26ee789 100644 --- a/pom.xml +++ b/pom.xml @@ -42,7 +42,7 @@ 1.8 1.8 UTF-8 - 1.6.10 + 1.6.21 true 1.3.2 0.44.0