@@ -7,7 +7,7 @@ A plugin to enable the use of Scoverage in a gradle Scala project.
77Usage
88-----
99
10- You can find instructions on how to apply the plugin at: http://plugins.gradle.org/plugin/org.scoverage
10+ You can find instructions on how to apply the plugin at http://plugins.gradle.org/plugin/org.scoverage
1111
1212### Available tasks
1313
@@ -18,7 +18,7 @@ You can find instructions on how to apply the plugin at: http://plugins.gradle.
1818 tasks to run only the desired tests. For example, to run only the unit tests and no other test
1919 tasks (e.g., integration tests), you can run ` reportTestScoverage ` .
2020
21- 2 . ` aggregateScoverage ` : An experimental support for aggregating coverage statistics in composite builds.
21+ 2 . ` aggregateScoverage ` : Aggregates coverage statistics in composite builds.
2222
2323 When applied on a project with sub-projects, the plugin will create the aggregation task ` aggregateScoverage ` , which
2424 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.
4141The plugin exposes multiple options that can be configured by setting them in an ` scoverage ` block within the project's
4242build script. These options are as follows:
4343
44- * ` scoverageVersion = <String> ` (default ` "1.3 .1" ` ): The version of the scoverage scalac plugin. This (gradle) plugin
44+ * ` scoverageVersion = <String> ` (default ` "1.4 .1" ` ): The version of the scoverage scalac plugin. This (gradle) plugin
4545should be compatible with all 1+ versions.
4646
4747* ` scoverageScalaVersion = <String> ` (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
113113In order to do so, simply add the arguments ` -x compileScala ` to the gradle execution.
114114For example: ` gradle reportScoverage -x compileScala ` .
115115
116+ Migration to 4.x
117+ ----------------
118+
119+ * Requires scoverage 1.4.1 or higher (and uses this version by default)
120+ * Requires application of the plugin to appropriate subprojects. A multi-module project might apply it to all.
121+
122+ ``` groovy
123+ plugins {
124+ id 'org.scoverage' version '4.0.0' apply false
125+ }
126+ allprojects {
127+ apply plugin: 'org.scoverage'
128+ }
129+ ```
130+
116131Migration to 3.x
117132----------------
118133
0 commit comments