You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**[pre-compile](http://scoverage.github.io/scoverage-maven-plugin/2.0.1/pre-compile-mojo.html)** and **[post-compile](http://scoverage.github.io/scoverage-maven-plugin/2.0.1/post-compile-mojo.html)** are internal goals, they configure Maven build in forked `scoverage` life cycle; don't use them.
Plugin is compatible with two Maven Scala compiler plugins:
50
+
-Plugin is compatible with two Maven Scala compiler plugins:
51
51
52
-
-[SBT Compiler Maven Plugin](https://github.com/sbt-compiler-maven-plugin/sbt-compiler-maven-plugin/) - version **1.0.0-beta5** or later required,
52
+
-[Scala Maven Plugin](http://davidb.github.io/scala-maven-plugin/) - version `3.0.0` or later required, [addScalacArgs](http://davidb.github.io/scala-maven-plugin/compile-mojo.html#addScalacArgs) and [analysisCacheFile](http://davidb.github.io/scala-maven-plugin/compile-mojo.html#analysisCacheFile) configuration parameters cannot be set directly, use project properties `addScalacArgs` and `analysisCacheFile` instead.
53
+
54
+
-[SBT Compiler Maven Plugin](https://github.com/sbt-compiler-maven-plugin/sbt-compiler-maven-plugin/) - version `1.0.0-beta5` or later required. Currently it works only with Scoverage Maven Plugin `1.4.11` or earlier.
53
55
54
-
-[Scala Maven Plugin](http://davidb.github.io/scala-maven-plugin/) - version **3.0.0** or later required, [addScalacArgs](http://davidb.github.io/scala-maven-plugin/compile-mojo.html#addScalacArgs) and [analysisCacheFile](http://davidb.github.io/scala-maven-plugin/compile-mojo.html#analysisCacheFile) configuration parameters cannot be set directly, use project properties 'addScalacArgs' and 'analysisCacheFile' instead.
56
+
- Starting with version `2.0.0` plugin supports Scala `2.12.8+`, `2.13.0+` and `3.2.0+`. For Scala `2.10` and `2.11` support please use version `1.4.11`.
57
+
- Plugin is not thread-safe, so it should not be used in multi-threaded builds.
55
58
56
59
57
-
#####Scoverage Maven plugin version
60
+
### Scoverage Maven plugin version
58
61
59
62
This can be set as project property.
60
63
@@ -67,9 +70,12 @@ This can be set as project property.
67
70
```
68
71
69
72
70
-
#####Scala version configuration
73
+
### Scala version configuration
71
74
72
-
Plugin supports Scala 2.12.8+, 2.13.0+ and 3.2.0+ versions by automatically loading and configuring matching `scalac-scoverage-plugin` Scalac SCoverage Plugin artifact. For this to work Scala version has to be set. It can be done by defining `scalaVersion` plugin configuration parameter or `scala.version` project property. Without this setting, coverage will not be calculated.
75
+
Plugin automatically loads and configures matching `scalac-scoverage-plugin` artifact when needed.
76
+
For this to work Scala version has to be set. It can be done by defining `scalaVersion` plugin configuration parameter or `scala.version` project property.
77
+
Without this setting, plugin will try to resolve Scala version from `scala-library` dependency of the project.
78
+
If all the attempts to resolve Scala version fail, then coverage will not be calculated.
73
79
74
80
```xml
75
81
<project>
@@ -99,7 +105,7 @@ or
99
105
</project>
100
106
```
101
107
102
-
The first method is better because once the property is defined it's value can be used in other places of the build file. For example in `scala-library` dependency version every Scala build should declare.
108
+
The first method is better because once the property is defined its value can be used in other places of the build file. For example in `scala-library` dependency version every Scala build should declare.
103
109
104
110
```xml
105
111
<project>
@@ -113,9 +119,7 @@ The first method is better because once the property is defined it's value can b
113
119
</project>
114
120
```
115
121
116
-
For Scala 2.10 and 2.11 support please use Scoverage Maven plugin `1.4.11`.
117
-
118
-
##### Scalac SCoverage plugin version configuration
122
+
### Scalac SCoverage plugin version configuration
119
123
120
124
Maven SCoverage plugin uses by default the latest version of the [scalac-scoverage-plugin](https://github.com/scoverage/scalac-scoverage-plugin) available on its release day.
121
125
If newer, better version of [scalac-scoverage-plugin](https://github.com/scoverage/scalac-scoverage-plugin) is available, it can be used instead.
@@ -149,11 +153,11 @@ or
149
153
</project>
150
154
```
151
155
152
-
#####Integration tests coverage check and reports
156
+
### Integration tests coverage check and reports
153
157
154
158
`integration-check` and `integration-report` mojos are similar to `check` and `report` mojos, but they execute forked `scoverage` life cycle up to `verify` phase (integration tests are usually executed in `integration-test` phase).
155
159
156
-
#####Aggregated reports for multi-module projects
160
+
### Aggregated reports for multi-module projects
157
161
158
162
There is no separate mojo for aggregated reports, there is `aggregate` parameter.
159
163
To additionally generate aggregated SCoverage report for root module, when generating regular reports,
@@ -261,11 +265,11 @@ or in `reporting/plugins` section when adding report to Maven generated site
261
265
</project>
262
266
```
263
267
264
-
#####Adding SCoverage report to site
268
+
### Adding SCoverage report to site
265
269
266
270
Add plugin to reporting section of your project and configure it to generate one of reporting mojos.
267
-
By default Maven executes all plugin's reporting mojos, but SCoverage plugin has three such mojos
268
-
and it does not make sense, to execute them all because every executed report will overwrite the previous one.
271
+
By default, Maven executes all plugin's reporting mojos, but SCoverage plugin has three such mojos,
272
+
and it does not make sense to execute them all because every executed report will overwrite the previous one.
269
273
Configure one of them depending on your case.
270
274
271
275
```xml
@@ -299,7 +303,7 @@ Which reporting mojo should be selected:
299
303
|[integration-report](http://scoverage.github.io/scoverage-maven-plugin/2.0.1/integration-report-mojo.html)| When using integration tests |
300
304
|[report-only](http://scoverage.github.io/scoverage-maven-plugin/2.0.1/report-only-mojo.html)| When coverage data was already generated (usually by [check](http://scoverage.github.io/scoverage-maven-plugin/2.0.1/check-mojo.html) or [integration-check](http://scoverage.github.io/scoverage-maven-plugin/2.0.1/integration-check-mojo.html) mojo) |
301
305
302
-
#####Customizing code instrumentation
306
+
### Customizing code instrumentation
303
307
304
308
If you want to customize plugin's configuration parameters used by compilation supporting part of the plugin, do it in 'plugins' or 'pluginManagement' section:
305
309
```xml
@@ -325,7 +329,7 @@ If you want to customize plugin's configuration parameters used by compilation s
325
329
Read [SBT SCoverage Plugin documentation](https://github.com/scoverage/sbt-scoverage) for more information about [highlighting](https://github.com/scoverage/sbt-scoverage#highlighting) and [excludedPackages](https://github.com/scoverage/sbt-scoverage#exclude-classes-and-packages).
326
330
327
331
328
-
#####Checking minimum test coverage level
332
+
### Checking minimum test coverage level
329
333
330
334
```xml
331
335
<project>
@@ -362,7 +366,7 @@ Run `mvn scoverage:check` to perform the check. See below if you want to use `mv
362
366
Read [SBT SCoverage Plugin documentation](https://github.com/scoverage/sbt-scoverage#minimum-coverage) for more information.
363
367
364
368
365
-
#####Checking minimum test coverage level AND adding report to site
369
+
### Checking minimum test coverage level AND adding report to site
0 commit comments