Skip to content

Installation

Requirements

Requirement Version
Gradle 7.6.4+
JVM 17+
Requirement Version
JVM 17+

Compatibility Matrix

Delta Coverage Gradle Min JVM
3.x 7.6.4+ 17
2.5.x 6.7.1 - 8.10.2 11
2.0 - 2.4 5.6 - 8.9.x 11
1.3.x 5.1 - 8.4.x 11

Install

Add Delta Coverage to your root project's build file:

plugins {
    id("io.github.gw-kit.delta-coverage") version "3.6.0"
}

Add Delta Coverage to your root project's build file:

plugins {
    id 'io.github.gw-kit.delta-coverage' version '3.6.0'
}

Download the CLI JAR from Maven Central or GitHub Releases:

curl -L -o delta-coverage-cli.jar \
  https://repo1.maven.org/maven2/io/github/gw-kit/delta-coverage-cli/3.6.0/delta-coverage-cli-3.6.0.jar

Root project only

The Gradle plugin must be applied to the root project, not subprojects. It automatically discovers all subprojects with test tasks.

Verify Installation

Run the following command to verify the plugin is installed:

./gradlew tasks --group="verification"

You should see deltaCoverage in the task list:

Verification tasks
------------------
deltaCoverage - Generates delta coverage reports for all views

Run the following command to verify the plugin is installed:

./gradlew tasks --group="verification"

You should see deltaCoverage in the task list:

Verification tasks
------------------
deltaCoverage - Generates delta coverage reports for all views

Run the following command to verify the CLI is working:

java -jar delta-coverage-cli.jar --help

You should see the usage information printed to the console.

What Gets Installed

When you apply the Gradle plugin:

  1. JaCoCo plugin is auto-applied to all projects (configurable)
  2. Delta coverage tasks are registered for each test task
  3. Report views are auto-created for test, integrationTest, etc.

CLI Tool

The CLI is a standalone JAR with no installation side effects. It reads coverage binary files, class files, and a diff file to produce reports. See the CLI Reference for full details.

Next Steps