Skip to content

Commit b837d3e

Browse files
committed
Fixed versions in the documentation
1 parent b1fc261 commit b837d3e

File tree

2 files changed

+19
-22
lines changed

2 files changed

+19
-22
lines changed

Diff for: README.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@ Kover Toolset:
1414
- [Kover features artifact](#kover-features-artifact)
1515

1616
## Kover Gradle Plugin
17-
For full information about latest stable release of Kover Gradle Plugin, please refer to the [documentation of the latest stable release](https://kotlin.github.io/kotlinx-kover/gradle-plugin).
18-
19-
A beta version of the plugin is also available. The DSL of this version is unstable and can be changed after receiving feedback.
20-
Detailed documentation is in the process of being written, please refer to the [migration guide](/kover-gradle-plugin/docs/migrations/migration-to-0.8.0.md).
17+
For full information about latest stable release of Kover Gradle Plugin, please refer to the [documentation](https://kotlin.github.io/kotlinx-kover/gradle-plugin).
2118

2219
### Features
2320

@@ -41,7 +38,7 @@ Add the following to your top-level build file:
4138

4239
```kotlin
4340
plugins {
44-
id("org.jetbrains.kotlinx.kover") version "0.7.6"
41+
id("org.jetbrains.kotlinx.kover") version "0.8.0"
4542
}
4643
```
4744
</details>
@@ -51,13 +48,13 @@ plugins {
5148

5249
```groovy
5350
plugins {
54-
id 'org.jetbrains.kotlinx.kover' version '0.7.6'
51+
id 'org.jetbrains.kotlinx.kover' version '0.8.0'
5552
}
5653
```
5754
</details>
5855

59-
After you applied Kover Gradle plugin, [Kover tasks](https://kotlin.github.io/kotlinx-kover/gradle-plugin#kover-tasks) will be created for generating reports and verification.
60-
E.g. to generate HTML report for non-Android project run `./gradlew koverHtmlReport` - this will automatically start code compilation, execution of instrumented tests, and an HTML report will be generated with measurement results in the build folder.
56+
After you applied Kover Gradle plugin, Kover tasks will be created for generating reports and verification.
57+
E.g. to generate HTML report run `./gradlew koverHtmlReport` - this will automatically start code compilation, execution of instrumented tests, and an HTML report will be generated with measurement results in the build folder.
6158

6259
It is also important that after applying Kover Gradle plugin, during the running tests, the classes are modified (instrumented) when loaded into the JVM which may lead to some performance degradation, or affect concurrent tests.
6360

@@ -76,7 +73,7 @@ buildscript {
7673
}
7774

7875
dependencies {
79-
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.7.6")
76+
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.8.0")
8077
}
8178
}
8279

@@ -95,7 +92,7 @@ buildscript {
9592
mavenCentral()
9693
}
9794
dependencies {
98-
classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.7.6'
95+
classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.8.0'
9996
}
10097
}
10198
@@ -119,7 +116,7 @@ in this case report will be generated for current project joined with `:another:
119116
## Kover CLI
120117
Standalone JVM application used for offline instrumentation and generation of human-readable reports.
121118

122-
[Documentation of the latest stable release](https://kotlin.github.io/kotlinx-kover/cli).
119+
[Documentation of the Kover CLI](https://kotlin.github.io/kotlinx-kover/cli).
123120

124121
## Kover offline instrumentation
125122
Offline instrumentation is the modification of class-files stored on disk to measure their coverage.
@@ -128,13 +125,12 @@ The ways of offline instrumentation and running of the instrumented applications
128125

129126
## Kover JVM agent
130127
JVM agent is a jar file that modifies the bytecode of loaded into the JVM classes in order to measure coverage.
131-
132-
It was added in the beta version. [documentations](/kover-jvm-agent/docs/index.md)
128+
[Documentations](https://kotlin.github.io/kotlinx-kover/jvm-agent).
133129

134130
## Kover features artifact
135131
A JVM dependency that allows to programmatically instrument class-files on a disk.
136132

137-
[Documentation of the latest stable release](https://kotlin.github.io/kotlinx-kover/offline-instrumentation/#instrumentation-by-kover-features)
133+
[Documentation of Kover features artifact](https://kotlin.github.io/kotlinx-kover/offline-instrumentation/#instrumentation-by-kover-features)
138134

139135
## Building locally and Contributing
140136

Diff for: kover-gradle-plugin/docs/index.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Gradle plugin that measures the coverage for tests running on the JVM and genera
2828
* [HTML report description](#html-report-description)
2929
* [Using JaCoCo](#using-jacoco)
3030
* [Implicit plugin dependencies](#implicit-plugin-dependencies)
31+
* [DSL reference](dokka)
3132

3233
## Features
3334

@@ -54,7 +55,7 @@ Add the following to your build file:
5455

5556
```kotlin
5657
plugins {
57-
id("org.jetbrains.kotlinx.kover") version "0.7.6"
58+
id("org.jetbrains.kotlinx.kover") version "0.8.0"
5859
}
5960
```
6061
For more information about application of the plugin, refer to the [relevant section](#apply-kover-gradle-plugin-in-project)
@@ -126,7 +127,7 @@ Add the following line to build file in each module of your Gradle build:
126127

127128
```kotlin
128129
plugins {
129-
id("org.jetbrains.kotlinx.kover") version "0.7.6"
130+
id("org.jetbrains.kotlinx.kover") version "0.8.0"
130131
}
131132
```
132133
It is recommended to apply the Kover Plugin in the root module, even if there is no source code or tests there.
@@ -224,7 +225,7 @@ Otherwise, the use of the plugin is identical to the use in the [multi-module Ko
224225
Add the following to the build file only in the `app` module of your Gradle build:
225226
```kotlin
226227
plugins {
227-
id("org.jetbrains.kotlinx.kover") version "0.7.6"
228+
id("org.jetbrains.kotlinx.kover") version "0.8.0"
228229
}
229230
```
230231

@@ -377,7 +378,7 @@ Add the following to build file in each module of your Gradle build:
377378

378379
```kotlin
379380
plugins {
380-
id("org.jetbrains.kotlinx.kover") version "0.7.6"
381+
id("org.jetbrains.kotlinx.kover") version "0.8.0"
381382
}
382383
```
383384
It is recommended to apply the Kover Plugin in the root module, even if there is no source code or tests there.
@@ -581,7 +582,7 @@ Add the following to build file in each module of your Gradle build:
581582

582583
```kotlin
583584
plugins {
584-
id("org.jetbrains.kotlinx.kover") version "0.7.6"
585+
id("org.jetbrains.kotlinx.kover") version "0.8.0"
585586
}
586587
```
587588
It is recommended to apply the Kover Plugin in the root module, even if there is no source code or tests there.
@@ -758,7 +759,7 @@ Add the following to your build file:
758759

759760
```kotlin
760761
plugins {
761-
id("org.jetbrains.kotlinx.kover") version "0.7.6"
762+
id("org.jetbrains.kotlinx.kover") version "0.8.0"
762763
}
763764
```
764765

@@ -776,7 +777,7 @@ buildscript {
776777
}
777778

778779
dependencies {
779-
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.7.6")
780+
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.8.0")
780781
}
781782
}
782783

@@ -792,7 +793,7 @@ buildscript {
792793
mavenCentral()
793794
}
794795
dependencies {
795-
classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.7.6'
796+
classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.8.0'
796797
}
797798
}
798799

0 commit comments

Comments
 (0)