https://github.com/rife2/bld-jacoco-report

bld Extension to Generate Code Coverage Reports with JaCoCo
https://github.com/rife2/bld-jacoco-report

bld build-system build-tool build-tool-plugin code-coverage coverage jacoco java

Last synced: 5 months ago
JSON representation

bld Extension to Generate Code Coverage Reports with JaCoCo

• Host: GitHub
• URL: https://github.com/rife2/bld-jacoco-report
• Owner: rife2
• License: apache-2.0
• Created: 2023-04-30T21:20:50.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-08-16T01:29:28.000Z (10 months ago)
• Last Synced: 2025-08-16T03:43:02.682Z (10 months ago)
• Topics: bld, build-system, build-tool, build-tool-plugin, code-coverage, coverage, jacoco, java
• Language: Java
• Homepage:
• Size: 719 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# [bld](https://rife2.com/bld) Extension to Generate Code Coverage Reports with [JaCoCo](https://www.eclemma.org/jacoco/)

[![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)

[![bld](https://img.shields.io/badge/2.3.0-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld)

[![Release](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.rife2.com%2Freleases%2Fcom%2Fuwyn%2Frife2%2Fbld-jacoco-report%2Fmaven-metadata.xml&color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-jacoco-report)

[![Snapshot](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.rife2.com%2Fsnapshots%2Fcom%2Fuwyn%2Frife2%2Fbld-jacoco-report%2Fmaven-metadata.xml&label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-jacoco-report)

[![GitHub CI](https://github.com/rife2/bld-jacoco-report/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-jacoco-report/actions/workflows/bld.yml)

To install the latest version, add the following to the `lib/bld/bld-wrapper.properties` file:

```properties

bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report

```

For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation.

## Generate Code Coverage Reports

To run the tests and generate the code coverage reports, add the floowing to your build file:

```java

@BuildCommand(summary = "Generates Jacoco Reports")

public void jacoco() throws Exception {

    new JacocoReportOperation()

            .fromProject(this)

            .execute();

}

```

```console

./bld compile jacoco

```

- [View Examples](https://github.com/rife2/bld-jacoco-report/tree/master/examples)

- The HTML, CSV and XML reports will be automatically created in the `build/reports/jacoco/test` directory.

- The execution coverage data will be automatically recorded in the `build/jacoco/jacoco.exec` file.

Please check the [JacocoReportOperation documentation](https://rife2.github.io/bld-jacoco-report/rife/bld/extension/JacocoReportOperation.html#method-summary) for all available configuration options.

### SonarQube/SonarCloud

To use a JaCoCo report with [sonar](https://www.sonarsource.com/), add something like the following to your `sonar-project.properties`:

```properties

sonar.organization=YOUR_ORGANIZATION

sonar.projectKey=YOUR_PROJECT_KEY

sonar.coverage.jacoco.xmlReportPaths=build/reports/jacoco/test/jacocoTestReport.xml

sonar.sources=src/main/java/

sonar.tests=src/test/java/

sonar.java.binaries=build/main,build/test

sonar.java.libraries=lib/compile/*.jar

```