From 72bdc5a04b35a85657e54bb219cdb18e18097d45 Mon Sep 17 00:00:00 2001 From: Stu Date: Wed, 20 Nov 2019 20:50:28 +0000 Subject: [PATCH] update README for next release --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e9b8dc4..53b93a1 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A plugin to enable the use of Scoverage in a gradle Scala project. Usage ----- -You can find instructions on how to apply the plugin at: http://plugins.gradle.org/plugin/org.scoverage +You can find instructions on how to apply the plugin at http://plugins.gradle.org/plugin/org.scoverage ### Available tasks @@ -18,7 +18,7 @@ You can find instructions on how to apply the plugin at: http://plugins.gradle. tasks to run only the desired tests. For example, to run only the unit tests and no other test tasks (e.g., integration tests), you can run `reportTestScoverage`. -2. `aggregateScoverage`: An experimental support for aggregating coverage statistics in composite builds. +2. `aggregateScoverage`: Aggregates coverage statistics in composite builds. When applied on a project with sub-projects, the plugin will create the aggregation task `aggregateScoverage`, which will first generate reports for each project individually (including the parent project), and will then generate an @@ -41,7 +41,7 @@ You can find instructions on how to apply the plugin at: http://plugins.gradle. The plugin exposes multiple options that can be configured by setting them in an `scoverage` block within the project's build script. These options are as follows: -* `scoverageVersion = ` (default `"1.3.1"`): The version of the scoverage scalac plugin. This (gradle) plugin +* `scoverageVersion = ` (default `"1.4.1"`): The version of the scoverage scalac plugin. This (gradle) plugin should be compatible with all 1+ versions. * `scoverageScalaVersion = ` (default `"2.12"`): The scala version of the scoverage scalac plugin. This will @@ -113,6 +113,21 @@ it is possible to only compile the code with the scoverage scalac plugin, thus r In order to do so, simply add the arguments `-x compileScala` to the gradle execution. For example: `gradle reportScoverage -x compileScala`. +Migration to 4.x +---------------- + +* Requires scoverage 1.4.1 or higher (and uses this version by default) +* Requires application of the plugin to appropriate subprojects. A multi-module project might apply it to all. + +```groovy +plugins { + id 'org.scoverage' version '4.0.0' apply false +} +allprojects { + apply plugin: 'org.scoverage' +} +``` + Migration to 3.x ----------------