From e88362a80e7a00c2e927a96ed4c86a3ca683fe16 Mon Sep 17 00:00:00 2001 From: Marcin Wisnicki Date: Sat, 3 May 2025 15:48:50 -0400 Subject: [PATCH] Warn about instrumenting builds --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 6185627..1b22e4e 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,16 @@ or if you have integration tests as well sbt clean coverage it:test ``` +This instruments standard build output so remember to clean again with coverage disabled before publishing your build to avoid including instrumentation. + To enable coverage directly in your build, use: ```scala coverageEnabled := true ``` +Note that this will result in code being always instrumented which is unlikely what you want. + + To generate the coverage reports run ``` sbt coverageReport