Reports

Delta Coverage generates reports in multiple formats. All reports show only coverage for changed code.

Report Formats

Format	Default	Description
Console	true	ASCII table printed to terminal
HTML	false	Interactive browser report
XML	false	Machine-readable for CI tools
Markdown	false	For PR comments

Configuration

Kotlin DSLGroovy DSLCLI

configure<io.github.surpsg.deltacoverage.gradle.DeltaCoverageConfiguration> {
    reports {
        console.set(true)   // default
        html.set(true)
        xml.set(true)
        markdown.set(true)
    }
}

deltaCoverageReport {
    reports {
        console = true   // default
        html = true
        xml = true
        markdown = true
    }
}

java -jar delta-coverage-cli.jar \
  --console \
  --html \
  --xml \
  --markdown \
  --diff-file changes.diff \
  --engine JACOCO \
  --coverage-binary build/jacoco/test.exec \
  --classes build/classes/java/main \
  --sources src/main/java

Output Location

Gradle PluginCLI

Reports are generated in build/reports/coverage-reports/delta-coverage/<view>/:

build/reports/coverage-reports/
└── delta-coverage/
    └── test/
        ├── html/
        │   └── index.html
        ├── report.xml
        └── report.md

Reports are generated in build/reports/delta-coverage/:

build/reports/delta-coverage/
├── html/
│   └── index.html
├── report.xml
└── report.md

Info

The CLI does not use report views, so there is no <view> subdirectory.

Custom Output Directory

Kotlin DSLGroovy DSLCLI

reports {
    reportDir.set("custom/reports/path")
}

reports {
    reportDir = 'custom/reports/path'
}

java -jar delta-coverage-cli.jar \
  --report-dir custom/reports/path \
  ...

Console Report

Printed automatically after each run:

+----------------------+----------+----------+--------+
| [test] Delta Coverage Stats                         |
+----------------------+----------+----------+--------+
| Class                | Lines    | Branches | Instr. |
+----------------------+----------+----------+--------|
| com.example.MyClass  | 85.71%   | 75%      | 88.24% |
| com.example.Service  | 92.31%   | 100%     | 94.12% |
+----------------------+----------+----------+--------+
| Total                | ✔ 88.89% | ✔ 83.33% | ✔ 91%  |
+----------------------+----------+----------+--------+
| Min expected         | 80%      | 70%      | 80%    |
+----------------------+----------+----------+--------+

HTML Report

Standard JaCoCo HTML report filtered to show only changed code:

Kotlin DSLGroovy DSLCLIGradle PluginCLI

reports {
    html.set(true)
}

reports {
    html = true
}

java -jar delta-coverage-cli.jar --html ...

Open build/reports/coverage-reports/delta-coverage/test/html/index.html in a browser.

Open build/reports/delta-coverage/html/index.html in a browser.

Markdown Report

Ideal for posting to PR comments:

Kotlin DSLGroovy DSLCLI

reports {
    markdown.set(true)
}

reports {
    markdown = true
}

java -jar delta-coverage-cli.jar --markdown ...

Output (report.md):

Class	Lines	Branches	Instr.
MyClass	85.71%	75%	88.24%
Service	92.31%	100%	94.12%
Total	🟢 88.89%	🟢 83.33%	🟢 91%
Min expected	80%	70%	80%

XML Report

For integration with CI tools and coverage aggregators:

Kotlin DSLGroovy DSLCLI

reports {
    xml.set(true)
}

reports {
    xml = true
}

java -jar delta-coverage-cli.jar --xml ...

Full Coverage Reports

Generate full coverage reports alongside delta reports:

Kotlin DSLGroovy DSLCLI

reports {
    html.set(true)
    fullCoverageReport.set(true)
}

reports {
    html = true
    fullCoverageReport = true
}

java -jar delta-coverage-cli.jar --html --full-coverage ...

This creates two report sets:

build/reports/coverage-reports/
├── delta-coverage/       # Only changed code
│   └── test/
└── full-coverage-report/ # Entire codebase
    └── test/

Use cases:

• Compare delta vs full coverage
• Generate coverage badges from full report
• Track overall project health

Recommended Setup

Local Development

Kotlin DSLGroovy DSLCLI

reports {
    console.set(true)
    html.set(true)
}

reports {
    console = true
    html = true
}

java -jar delta-coverage-cli.jar --console --html ...

CI Pipeline

Kotlin DSLGroovy DSLCLI

reports {
    console.set(true)
    html.set(true)
    markdown.set(true)  // For PR comments
    xml.set(true)       // For coverage tools
}

reports {
    console = true
    html = true
    markdown = true  // For PR comments
    xml = true       // For coverage tools
}

java -jar delta-coverage-cli.jar \
  --console --html --markdown --xml ...