Skip to content

Commit

Permalink
scoverage#132 clarify when reports are generated and when minimums ar…
Browse files Browse the repository at this point in the history
…e applied

README changes and version increment
  • Loading branch information
RichardBradley committed Aug 19, 2015
1 parent 5237e3d commit 1c806c8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ discussion on scoverage.

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

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

## Multi project reports

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).
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).)

(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.)

## Exclude classes and packages

Expand Down Expand Up @@ -94,6 +98,9 @@ coverageMinimum := 80
coverageFailOnMinimum := true
```

These settings will be enforced when the reports are generated.
If you generate an aggregate report using `coverageAggregate` then these settings will apply to that report.

## Highlighting

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:
Expand Down
2 changes: 1 addition & 1 deletion version.sbt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version in ThisBuild := "1.3.1"
version in ThisBuild := "1.3.2"

0 comments on commit 1c806c8

Please sign in to comment.