Skip to content

Commit

Permalink
Update versions in pom.xml and documentation after 1.2.4 release (#1556)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored Nov 10, 2022
1 parent e8dbfb0 commit 7dcf067
Show file tree
Hide file tree
Showing 17 changed files with 35 additions and 23 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ DiKTat is a strict [coding standard ](info/guide/diktat-coding-convention.md) fo
as AST visitors on the top of [KTlint](https://ktlint.github.io/). It can be used for detecting and autofixing code smells in CI/CD process.
The full list of available supported rules and inspections can be found [here](info/available-rules.md).

Now diKTat was already added to the lists of [static analysis tools](https://github.com/analysis-tools-dev/static-analysis), to [kotlin-awesome](https://github.com/KotlinBy/awesome-kotlin) and to [kompar](https://catalog.kompar.tools/Analyzer/diKTat/1.2.3). Thanks to the community for this support!
Now diKTat was already added to the lists of [static analysis tools](https://github.com/analysis-tools-dev/static-analysis), to [kotlin-awesome](https://github.com/KotlinBy/awesome-kotlin) and to [kompar](https://catalog.kompar.tools/Analyzer/diKTat/1.2.4). Thanks to the community for this support!

## See first

Expand Down Expand Up @@ -56,11 +56,11 @@ Main features of diktat are the following:
curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.47.1/ktlint && chmod a+x ktlint
```

1. Load diKTat manually: [here](https://github.com/saveourtool/diKTat/releases/download/v1.2.3/diktat-1.2.3.jar)
1. Load diKTat manually: [here](https://github.com/saveourtool/diKTat/releases/download/v1.2.4/diktat-1.2.4.jar)

**OR** use `curl`:
```console
$ curl -sSLO https://github.com/saveourtool/diKTat/releases/download/v1.2.3/diktat-1.2.3.jar
$ curl -sSLO https://github.com/saveourtool/diKTat/releases/download/v1.2.4/diktat-1.2.4.jar
```

### Run diKTat
Expand Down Expand Up @@ -182,7 +182,7 @@ This plugin is available since version 0.1.5. You can see how the plugin is conf

```kotlin
plugins {
id("org.cqfn.diktat.diktat-gradle-plugin") version "1.2.3"
id("org.cqfn.diktat.diktat-gradle-plugin") version "1.2.4"
}
```

Expand All @@ -193,7 +193,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath("org.cqfn.diktat:diktat-gradle-plugin:1.2.3")
classpath("org.cqfn.diktat:diktat-gradle-plugin:1.2.4")
}
}

Expand All @@ -215,9 +215,9 @@ Also in `diktat` extension you can configure different reporters and their outpu
If `output` is set, it should be a file path. If not set, results will be printed to stdout.
```kotlin
diktat {
// since 1.2.3 to keep in line with maven properties
// since 1.2.4 to keep in line with maven properties
reporter = "json" // "html", "json", "plain" (default), "sarif"
// before 1.2.3
// before 1.2.4
// reporterType = "json" // "html", "json", "plain" (default), "sarif"

output = "someFile.json"
Expand Down Expand Up @@ -259,7 +259,7 @@ spotless {
```kotlin
spotless {
kotlin {
diktat("1.2.3").configFile("full/path/to/diktat-analysis.yml")
diktat("1.2.4").configFile("full/path/to/diktat-analysis.yml")
}
}
```
Expand Down Expand Up @@ -290,7 +290,7 @@ Diktat can be run via spotless-maven-plugin since version 2.8.0

```xml
<diktat>
<version>1.2.3</version> <!-- optional -->
<version>1.2.4</version> <!-- optional -->
<configFile>full/path/to/diktat-analysis.yml</configFile> <!-- optional, configuration file path -->
</diktat>
```
Expand Down
2 changes: 1 addition & 1 deletion diktat-common/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.cqfn.diktat</groupId>
<artifactId>diktat-parent</artifactId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
</parent>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion diktat-gradle-plugin/gradle-plugin-marker/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<artifactId>diktat-gradle-plugin</artifactId>
<groupId>org.cqfn.diktat</groupId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion diktat-gradle-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<artifactId>diktat-parent</artifactId>
<groupId>org.cqfn.diktat</groupId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion diktat-maven-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<artifactId>diktat-parent</artifactId>
<groupId>org.cqfn.diktat</groupId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion diktat-rules/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.cqfn.diktat</groupId>
<artifactId>diktat-parent</artifactId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
</parent>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion diktat-ruleset/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>org.cqfn.diktat</groupId>
<artifactId>diktat-parent</artifactId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion diktat-test-framework/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>org.cqfn.diktat</groupId>
<artifactId>diktat-parent</artifactId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
</parent>

<dependencies>
Expand Down
2 changes: 1 addition & 1 deletion examples/gradle-groovy-dsl/build.gradle
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
plugins {
id "org.cqfn.diktat.diktat-gradle-plugin" version "1.2.3"
id "org.cqfn.diktat.diktat-gradle-plugin" version "1.2.4"
}

repositories {
Expand Down
3 changes: 3 additions & 0 deletions examples/gradle-groovy-dsl/diktat-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,9 @@
# Checks that property in KDoc present in class
- name: KDOC_EXTRA_PROPERTY
enabled: true
# There's a property in KDoc which is already present
- name: KDOC_DUPLICATE_PROPERTY
enabled: true
# Checks that KDoc in constructor has property tag but with comment inside constructor
- name: KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT
enabled: true
Expand Down
3 changes: 3 additions & 0 deletions examples/gradle-kotlin-dsl-multiproject/diktat-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,9 @@
# Checks that property in KDoc present in class
- name: KDOC_EXTRA_PROPERTY
enabled: true
# There's a property in KDoc which is already present
- name: KDOC_DUPLICATE_PROPERTY
enabled: true
# Checks that KDoc in constructor has property tag but with comment inside constructor
- name: KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT
enabled: true
Expand Down
2 changes: 1 addition & 1 deletion examples/gradle-kotlin-dsl/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
plugins {
id("org.cqfn.diktat.diktat-gradle-plugin") version "1.2.3"
id("org.cqfn.diktat.diktat-gradle-plugin") version "1.2.4"
}

repositories {
Expand Down
3 changes: 3 additions & 0 deletions examples/gradle-kotlin-dsl/diktat-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,9 @@
# Checks that property in KDoc present in class
- name: KDOC_EXTRA_PROPERTY
enabled: true
# There's a property in KDoc which is already present
- name: KDOC_DUPLICATE_PROPERTY
enabled: true
# Checks that KDoc in constructor has property tag but with comment inside constructor
- name: KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT
enabled: true
Expand Down
3 changes: 3 additions & 0 deletions examples/maven/diktat-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,9 @@
# Checks that property in KDoc present in class
- name: KDOC_EXTRA_PROPERTY
enabled: true
# There's a property in KDoc which is already present
- name: KDOC_DUPLICATE_PROPERTY
enabled: true
# Checks that KDoc in constructor has property tag but with comment inside constructor
- name: KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT
enabled: true
Expand Down
4 changes: 2 additions & 2 deletions examples/maven/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
<groupId>org.cqfn.diktat</groupId>
<artifactId>diktat-examples-maven</artifactId>
<packaging>pom</packaging>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>

<properties>
<diktat.version>1.2.3</diktat.version>
<diktat.version>1.2.4</diktat.version>
</properties>

<!-- This is an example of how DiKTat performs static code analysis.
Expand Down
2 changes: 1 addition & 1 deletion info/buildSrc/gradle.properties
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version=1.2.4-SNAPSHOT
version=1.2.5-SNAPSHOT
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>org.cqfn.diktat</groupId>
<artifactId>diktat-parent</artifactId>
<version>1.2.4-SNAPSHOT</version>
<version>1.2.5-SNAPSHOT</version>
<packaging>pom</packaging>

<name>diktat</name>
Expand Down Expand Up @@ -52,7 +52,7 @@
<surefire.junit5.tree-reporter.version>1.1.0</surefire.junit5.tree-reporter.version>
<guava.version>31.1-jre</guava.version>
<commons-cli.version>1.5.0</commons-cli.version>
<diktat-check.version>1.2.3</diktat-check.version>
<diktat-check.version>1.2.4</diktat-check.version>
<kotlinpoet.version>1.12.0</kotlinpoet.version>
<detekt.version>1.21.0.1</detekt.version>
<dokka.version>1.7.20</dokka.version>
Expand Down

0 comments on commit 7dcf067

Please sign in to comment.