Skip to content

Commit

Permalink
Fixed versions in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
shanshin committed May 15, 2024
1 parent b1fc261 commit b837d3e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 22 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ Kover Toolset:
- [Kover features artifact](#kover-features-artifact)

## Kover Gradle Plugin
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).

A beta version of the plugin is also available. The DSL of this version is unstable and can be changed after receiving feedback.
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).
For full information about latest stable release of Kover Gradle Plugin, please refer to the [documentation](https://kotlin.github.io/kotlinx-kover/gradle-plugin).

### Features

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

```kotlin
plugins {
id("org.jetbrains.kotlinx.kover") version "0.7.6"
id("org.jetbrains.kotlinx.kover") version "0.8.0"
}
```
</details>
Expand All @@ -51,13 +48,13 @@ plugins {

```groovy
plugins {
id 'org.jetbrains.kotlinx.kover' version '0.7.6'
id 'org.jetbrains.kotlinx.kover' version '0.8.0'
}
```
</details>

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.
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.
After you applied Kover Gradle plugin, Kover tasks will be created for generating reports and verification.
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.

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.

Expand All @@ -76,7 +73,7 @@ buildscript {
}

dependencies {
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.7.6")
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.8.0")
}
}

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

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

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

## Kover JVM agent
JVM agent is a jar file that modifies the bytecode of loaded into the JVM classes in order to measure coverage.

It was added in the beta version. [documentations](/kover-jvm-agent/docs/index.md)
[Documentations](https://kotlin.github.io/kotlinx-kover/jvm-agent).

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

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

## Building locally and Contributing

Expand Down
17 changes: 9 additions & 8 deletions kover-gradle-plugin/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Gradle plugin that measures the coverage for tests running on the JVM and genera
* [HTML report description](#html-report-description)
* [Using JaCoCo](#using-jacoco)
* [Implicit plugin dependencies](#implicit-plugin-dependencies)
* [DSL reference](dokka)

## Features

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

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

```kotlin
plugins {
id("org.jetbrains.kotlinx.kover") version "0.7.6"
id("org.jetbrains.kotlinx.kover") version "0.8.0"
}
```
It is recommended to apply the Kover Plugin in the root module, even if there is no source code or tests there.
Expand Down Expand Up @@ -224,7 +225,7 @@ Otherwise, the use of the plugin is identical to the use in the [multi-module Ko
Add the following to the build file only in the `app` module of your Gradle build:
```kotlin
plugins {
id("org.jetbrains.kotlinx.kover") version "0.7.6"
id("org.jetbrains.kotlinx.kover") version "0.8.0"
}
```

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

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

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

```kotlin
plugins {
id("org.jetbrains.kotlinx.kover") version "0.7.6"
id("org.jetbrains.kotlinx.kover") version "0.8.0"
}
```

Expand All @@ -776,7 +777,7 @@ buildscript {
}

dependencies {
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.7.6")
classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.8.0")
}
}

Expand All @@ -792,7 +793,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.7.6'
classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.8.0'
}
}
Expand Down

0 comments on commit b837d3e

Please sign in to comment.