Skip to content

Commit a3b3267

Browse files
committed
README file update after 1.4.0 release.
1 parent 90b72ba commit a3b3267

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,35 @@ scoverage-maven-plugin is a plugin for Maven that integrates the scoverage code
1515

1616
mostly used mojos:
1717

18-
- **[check](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/check-mojo.html)** goal compiles classes with instrumentation, runs unit tests and checks coverage,
18+
- **[check](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/check-mojo.html)** goal compiles classes with instrumentation, runs unit tests and checks coverage,
1919

20-
- **[report](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/report-mojo.html)** goal compiles classes with instrumentation, runs unit tests and generates reports,
20+
- **[report](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/report-mojo.html)** goal compiles classes with instrumentation, runs unit tests and generates reports,
2121

22-
- **[integration-check](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/integration-check-mojo.html)** goal compiles classes with instrumentation, runs unit and integration tests and checks coverage,
22+
- **[integration-check](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/integration-check-mojo.html)** goal compiles classes with instrumentation, runs unit and integration tests and checks coverage,
2323

24-
- **[integration-report](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/integration-report-mojo.html)** goal compiles classes with instrumentation, runs unit and integration tests and generates reports,
24+
- **[integration-report](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/integration-report-mojo.html)** goal compiles classes with instrumentation, runs unit and integration tests and generates reports,
2525

2626
additional, sometimes useful, mojos:
2727

28-
- **[test](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/test-mojo.html)** goal compiles classes with instrumentation and runs unit tests,
28+
- **[test](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/test-mojo.html)** goal compiles classes with instrumentation and runs unit tests,
2929

30-
- **[integration-test](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/integration-test-mojo.html)** goal compiles classes with instrumentation and runs unit and integration tests,
30+
- **[integration-test](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/integration-test-mojo.html)** goal compiles classes with instrumentation and runs unit and integration tests,
3131

32-
- **[check-only](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/check-only-mojo.html)** goal only checks coverage using coverage data generated earlier in the build (by **test**, **report**, **integration-test** or **integration-report** goal).
32+
- **[check-only](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/check-only-mojo.html)** goal only checks coverage using coverage data generated earlier in the build (by **test**, **report**, **integration-test** or **integration-report** goal).
3333

34-
- **[report-only](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/report-only-mojo.html)** goal generates reports using coverage data generated earlier in the build (by **test**, **check**, **integration-test** or **integration-check** goal),
34+
- **[report-only](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/report-only-mojo.html)** goal generates reports using coverage data generated earlier in the build (by **test**, **check**, **integration-test** or **integration-check** goal),
3535

36-
- **[package](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/package-mojo.html)** goal generates artifact file containing instrumented classes (e.g. for testing outside of the Maven build),
36+
- **[package](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/package-mojo.html)** goal generates artifact file containing instrumented classes (e.g. for testing outside of the Maven build),
3737

3838
internal mojos:
3939

40-
- **[pre-compile](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/pre-compile-mojo.html)** and **[post-compile](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/post-compile-mojo.html)** are internal goals, they configure Maven build in forked `scoverage` life cycle; don't use them.
40+
- **[pre-compile](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/pre-compile-mojo.html)** and **[post-compile](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/post-compile-mojo.html)** are internal goals, they configure Maven build in forked `scoverage` life cycle; don't use them.
4141

4242
Maven generated plugin documentation:
4343

4444
| Version | Documentation |
4545
|------------------|--------------------------------------------------------------------------------------------------|
46-
| `1.3.0` | [Plugin Info](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/plugin-info.html) |
47-
| `1.4.0-RC1` | [Plugin Info](http://scoverage.github.io/scoverage-maven-plugin/1.4.0-RC1/plugin-info.html) |
46+
| `1.4.0` | [Plugin Info](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/plugin-info.html) |
4847

4948
##### Prerequisities / limitations
5049

@@ -62,20 +61,20 @@ This can be set as project property.
6261
```xml
6362
<project>
6463
<properties>
65-
<scoverage.plugin.version>1.3.0</scoverage.plugin.version>
64+
<scoverage.plugin.version>1.4.0</scoverage.plugin.version>
6665
</properties>
6766
</project>
6867
```
6968

7069

7170
##### Scala version configuration
7271

73-
Plugin supports Scala 2.10.x and 2.11.x versions by automatically loading and configuring scalac-scoverage-plugin_2.10 or scalac-scoverage-plugin_2.11 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.
72+
Plugin supports Scala 2.10.x, 2.11.x, 2.12.x and 2.13.x versions by automatically loading and configuring scalac-scoverage-plugin_2.10, scalac-scoverage-plugin_2.11, scalac-scoverage-plugin_2.12 or scalac-scoverage-plugin_2.13 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.
7473

7574
```xml
7675
<project>
7776
<properties>
78-
<scala.version>2.11.8</scala.version>
77+
<scala.version>2.13.0</scala.version>
7978
</properties>
8079
</project>
8180
```
@@ -91,7 +90,7 @@ or
9190
<artifactId>scoverage-maven-plugin</artifactId>
9291
<version>${scoverage.plugin.version}</version>
9392
<configuration>
94-
<scalaVersion>2.11.8</scalaVersion>
93+
<scalaVersion>2.13.0</scalaVersion>
9594
<!-- other parameters -->
9695
</configuration>
9796
</plugin>
@@ -123,7 +122,7 @@ It can be configured by defining `scalacPluginVersion` plugin configuration para
123122
```xml
124123
<project>
125124
<properties>
126-
<scoverage.scalacPluginVersion>1.3.0</scoverage.scalacPluginVersion>
125+
<scoverage.scalacPluginVersion>1.4.0</scoverage.scalacPluginVersion>
127126
</properties>
128127
</project>
129128
```
@@ -139,7 +138,7 @@ or
139138
<artifactId>scoverage-maven-plugin</artifactId>
140139
<version>${scoverage.plugin.version}</version>
141140
<configuration>
142-
<scalacPluginVersion>1.3.0</scalacPluginVersion>
141+
<scalacPluginVersion>1.4.0</scalacPluginVersion>
143142
<!-- other parameters -->
144143
</configuration>
145144
</plugin>
@@ -293,9 +292,9 @@ Which reporting mojo should be selected:
293292

294293
| Reporting mojo | When |
295294
|----------------------|-----------------------------------------------|
296-
| [report](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/report-mojo.html) | When not using integration tests (most cases) |
297-
| [integration-report](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/integration-report-mojo.html) | When using integration tests |
298-
| [report-only](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/report-only-mojo.html) | When coverage data was already generated (usually by [check](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/check-mojo.html) or [integration-check](http://scoverage.github.io/scoverage-maven-plugin/1.3.0/integration-check-mojo.html) mojo) |
295+
| [report](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/report-mojo.html) | When not using integration tests (most cases) |
296+
| [integration-report](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/integration-report-mojo.html) | When using integration tests |
297+
| [report-only](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/report-only-mojo.html) | When coverage data was already generated (usually by [check](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/check-mojo.html) or [integration-check](http://scoverage.github.io/scoverage-maven-plugin/1.4.0/integration-check-mojo.html) mojo) |
299298

300299
##### Customizing code instrumentation
301300

@@ -459,7 +458,7 @@ If you want to set multiple properties from within `<additionalForkedProjectProp
459458

460459
## Examples
461460

462-
There are many [example projects](https://github.com/scoverage/scoverage-maven-samples/tree/scoverage-maven-samples-1.3.0/).
461+
There are many [example projects](https://github.com/scoverage/scoverage-maven-samples/tree/scoverage-maven-samples-1.4.0/).
463462
Go to one of them and run `mvn site`.
464463

465464
## License

0 commit comments

Comments
 (0)