Skip to content

Commit 1c806c8

Browse files
#132 clarify when reports are generated and when minimums are applied
README changes and version increment
1 parent 5237e3d commit 1c806c8

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

Diff for: README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ discussion on scoverage.
1414

1515
Add the plugin to your build with the following in project/plugins.sbt:
1616
```scala
17-
addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.3.1")
17+
addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.3.2")
1818
```
1919

2020
Then run the your tests with coverage enabled by entering:
@@ -58,7 +58,11 @@ Next, the keys have been renamed slightly. The new names begin with coverageXXX,
5858

5959
## Multi project reports
6060

61-
By default, scoverage will generate reports for each project seperately. You can merge them into an aggregated report by invoking `sbt coverageAggregate`. Note, you must do this after all the coverage data is complete as a separate command, so you cannot do `sbt coverage test coverageAggregate` (at least until a way around this is found).
61+
By default, scoverage will generate reports for each project seperately. You can merge them into an aggregated report by invoking `sbt coverageAggregate`.
62+
63+
(Note, you must do this after all the coverage data is complete as a separate command, so you cannot do `sbt coverage test coverageAggregate` (at least until a way around this is found).)
64+
65+
(You must have first run `sbt coverageReport` for `coverageAggregate` to work. It aggregates over the sub-projects' report xml rather than over the coverage data directly.)
6266

6367
## Exclude classes and packages
6468

@@ -94,6 +98,9 @@ coverageMinimum := 80
9498
coverageFailOnMinimum := true
9599
```
96100

101+
These settings will be enforced when the reports are generated.
102+
If you generate an aggregate report using `coverageAggregate` then these settings will apply to that report.
103+
97104
## Highlighting
98105

99106
If you are using Scala 2.11.1 or less, then highlighting will not work (due to this bug which was fixed in 2.11.2 https://github.com/scala/scala/pull/3799). In that case you must disable highlighting by adding the following to your build:

Diff for: version.sbt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version in ThisBuild := "1.3.1"
1+
version in ThisBuild := "1.3.2"

0 commit comments

Comments
 (0)