Release 0.7.2

PR #416

CHANGELOG.md

@@ -1,3 +1,26 @@
+0.7.2 / 2023-06-26
+===================
+### Features
+* [`#362`](https://github.com/Kotlin/kotlinx-kover/issues/362) Removed the dependency on the order of applying of the plugin
+* [`#229`](https://github.com/Kotlin/kotlinx-kover/issues/229) Added task to print coverage to logs
+* [`#394`](https://github.com/Kotlin/kotlinx-kover/issues/394) Added DSL accessors for Kover Default report tasks
+* [`#400`](https://github.com/Kotlin/kotlinx-kover/issues/400) Added descriptions for Kover report tasks
+* [`#409`](https://github.com/Kotlin/kotlinx-kover/issues/409) Added ability to generate reports even if there are no tests in the project
+* Upgraded default JaCoCo version to `0.8.10`
+
+### Bugfixes
+* [`#413`](https://github.com/Kotlin/kotlinx-kover/issues/413) Fixed issues with cache miss of build cache at the time of project relocation
+
+### Documentation
+* Fixed docs typo: `dependency {}` -> `dependencies {}`
+
+### Internal features
+* Moved Kover Gradle Plugin to the separate subproject
+* Migrated from buildSrc to composite build
+* Added support of the version catalog
+* IntelliJ coverage dependency versions upgraded to `1.0.724`
+
+
 0.7.1 / 2023-06-01
 ===================
 ### Features

README.md

@@ -36,7 +36,7 @@ Add the following to your top-level build file:
 
 ```kotlin
 plugins {
-     id("org.jetbrains.kotlinx.kover") version "0.7.1"
+     id("org.jetbrains.kotlinx.kover") version "0.7.2"
 }
 ```
 </details>
@@ -46,7 +46,7 @@ plugins {
 
 ```groovy
 plugins {
-    id 'org.jetbrains.kotlinx.kover' version '0.7.1'
+    id 'org.jetbrains.kotlinx.kover' version '0.7.2'
 }
 ```
 </details>
@@ -69,7 +69,7 @@ buildscript {
     }
 
     dependencies {
-        classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.7.1")
+        classpath("org.jetbrains.kotlinx:kover-gradle-plugin:0.7.2")
     }
 }
 
@@ -88,7 +88,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.7.1'
+        classpath 'org.jetbrains.kotlinx:kover-gradle-plugin:0.7.2'
     }
 }
   

docs/cli/index.md

@@ -71,8 +71,8 @@ configurations.register("koverCli") {
 }
 
 dependencies {
-    runtimeOnly("org.jetbrains.kotlinx:kover-offline-runtime:0.7.1")
-    add("koverCli", "org.jetbrains.kotlinx:kover-cli:0.7.1")
+    runtimeOnly("org.jetbrains.kotlinx:kover-offline-runtime:0.7.2")
+    add("koverCli", "org.jetbrains.kotlinx:kover-cli:0.7.2")
 
     testImplementation(kotlin("test"))
 }

docs/gradle-plugin/configuring.md

@@ -11,7 +11,7 @@
 ## Configuring default reports
 
 The full configuration for default reports is given below.
-These reports are avialable by default when Kover is applied by tasks such as  `:koverHtmlReport` and `:koverXmlReport`.
+These reports are available by default when Kover is applied by tasks such as  `:koverHtmlReport`, `:koverXmlReport` and `:koverLog`.
 
 See also [verification explanations](#verification)
 
@@ -146,6 +146,43 @@ koverReport {
                 maxBound(98)
             }
         }
+
+        // configure coverage logging
+        log {
+            //  print coverage when running the `check` task
+            onCheck = true
+
+            // overriding filters only for the logging report
+            filters {
+                // exclusions for logging reports
+                excludes {
+                  // excludes class by fully-qualified JVM class name, wildcards '*' and '?' are available
+                  classes("com.example.*")
+                  // excludes all classes located in specified package and it subpackages, wildcards '*' and '?' are available
+                  packages("com.another.subpackage")
+                  // excludes all classes and functions, annotated by specified annotations (with BINARY or RUNTIME AnnotationRetention), wildcards '*' and '?' are available
+                  annotatedBy("*Generated*")
+                }
+
+                // inclusions for logging reports
+                includes {
+                  // includes class by fully-qualified JVM class name, wildcards '*' and '?' are available
+                  classes("com.example.*")
+                  // includes all classes located in specified package and it subpackages
+                  packages("com.another.subpackage")
+                }
+            }
+            // Add a header line to the output before the lines with coverage
+            header = null
+            // Format of the strings to print coverage for the specified in `groupBy` group
+            format = "<entity> line coverage: <value>%"
+            // Specifies by which entity the code for separate coverage evaluation will be grouped
+            groupBy = GroupingEntityType.APPLICATION
+            // Specifies which metric is used for coverage evaluation
+            coverageUnits = MetricType.LINE
+            // Specifies aggregation function that will be calculated over all the elements of the same group
+            aggregationForGroup = AggregationType.COVERED_PERCENTAGE
+        }
     }
 }
 ```
@@ -287,6 +324,43 @@ koverReport {
                 maxBound(98)
             }
         }
+
+        // configure coverage logging for `release` build variant (task `koverLogRelease`)
+        log {
+            //  print coverage when running the `check` task
+            onCheck = true
+
+            // overriding filters only for the logging report
+            filters {
+              // exclusions for logging reports
+              excludes {
+                // excludes class by fully-qualified JVM class name, wildcards '*' and '?' are available
+                classes("com.example.*")
+                // excludes all classes located in specified package and it subpackages, wildcards '*' and '?' are available
+                packages("com.another.subpackage")
+                // excludes all classes and functions, annotated by specified annotations (with BINARY or RUNTIME AnnotationRetention), wildcards '*' and '?' are available
+                annotatedBy("*Generated*")
+              }
+
+              // inclusions for logging reports
+              includes {
+                // includes class by fully-qualified JVM class name, wildcards '*' and '?' are available
+                classes("com.example.*")
+                // includes all classes located in specified package and it subpackages
+                packages("com.another.subpackage")
+              }
+            }
+            // Add a header line to the output before the lines with coverage
+            header = null
+            // Format of the strings to print coverage for the specified in `groupBy` group
+            format = "<entity> line coverage: <value>%"
+            // Specifies by which entity the code for separate coverage evaluation will be grouped
+            groupBy = GroupingEntityType.APPLICATION
+            // Specifies which metric is used for coverage evaluation
+            coverageUnits = MetricType.LINE
+            // Specifies aggregation function that will be calculated over all the elements of the same group
+            aggregationForGroup = AggregationType.COVERED_PERCENTAGE
+        }
     }
 }
 ```
@@ -332,31 +406,47 @@ koverReport {
         }
 
         xml {
-            // overriding filters for default xml report 
+            // overriding filters for default xml report
             filters {
               excludes {  }
               includes {  }
             }
         }
+
+        log {
+            // overriding filters for logging report
+            filters {
+              excludes {  }
+              includes {  }
+            }   
+        }
     }  
     androidReports("release") {
-        // overriding filters for reports for `release` build variant 
+        // overriding filters for reports for `release` build variant
         filters {
             excludes {
-                // exclusions for reports for `release` build variant 
+                // exclusions for reports for `release` build variant
             }
             includes {
-                // inclusions for default reports for `release` build variant 
+                // inclusions for default reports for `release` build variant
             }
         }
 
         xml {
-            // overriding filters for xml report for `release` build variant  
+            // overriding filters for xml report for `release` build variant
             filters {
               excludes {  }
               includes {  }
             }
         }
+
+        log {
+          // overriding filters for logging report for `release` build variant
+          filters {
+            excludes {  }
+            includes {  }
+          }
+        }
     }
 }
 ```