This is an automated email from the ASF dual-hosted git repository.
chia7712 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new f2ce4dc3cb8 MINOR: Enhance reportCoverage docs with coverage report
output paths (#20736)
f2ce4dc3cb8 is described below
commit f2ce4dc3cb8229c0a057a579f022255613c9b2f9
Author: Ming-Yen Chung <[email protected]>
AuthorDate: Fri Oct 24 00:23:24 2025 +0800
MINOR: Enhance reportCoverage docs with coverage report output paths
(#20736)
This PR updates the documentation to clearly specify the HTML report
paths generated by the reportCoverage task.
We use Scoverage for the Scala module (:core) and JaCoCo for all other
modules. This ensures developers can quickly locate all generated
coverage reports.
Reviewers: Chia-Ping Tsai <[email protected]>
---
README.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f367d1b9bf5..fbd03dfc026 100644
--- a/README.md
+++ b/README.md
@@ -89,7 +89,13 @@ Generate coverage reports for the whole project:
Generate coverage for a single module, i.e.:
./gradlew clients:reportCoverage -PenableTestCoverage=true
-Dorg.gradle.parallel=false
-
+
+Coverage reports are located within the module's build directory, categorized
by module type:
+
+Core Module (:core): `core/build/reports/scoverageTest/index.html`
+
+Other Modules: `<module>/build/reports/jacoco/test/html/index.html`
+
### Building a binary release gzipped tar ball ###
./gradlew clean releaseTarGz
