Kover Gradle Plugin/kotlinx.kover.gradle.plugin.dsl/KoverProjectExtension/merge

merge

abstract fun merge(block: Action<KoverMergingConfig>)(source)

Configuring a merged report.

Attention! Usage of this block breaks project isolation and is incompatible with the configuration cache! If you need configuration cache support, please explicitly configure Kover plugin in each project using currentProject blocks.

Used as a shortcut for group configuration of the plugin in several projects and merging reports. If you specify this block without additional commands

kover {
    merge {
    }
}

it will be equivalent to this code

val thisProject = project
subprojects {
    apply("org.jetbrains.kotlinx.kover")
    thisProject.dependencies.add("kover", this)

    // apply values from `useJacoco` and `jacocoVersion`
}

As a result, a merged report will be created in the project in which this merge block was called (merging project).

It is acceptable to limit the projects in which the configuration will take place by adding filters:

kover {
    merge {
        subprojects {
            it.name != "uncovered"
        }
    }
}

This way Kover plugin will not be applied in a project named uncovered.

If you specify several filters, Kover plugin will be applied in the project if at least one of these filters will return true.

Full list of functions:

kover {
    merge {
        // include all subprojects
        subprojects()

        // include subprojects that have passed the filter
        subprojects {
            // filter predicate
        }

        // include all projects of the build
        allProjects()

        // include all projects of the build that have passed the filter
        allProjects {
            // filter predicate
        }

        // include projects by name or path
        projects("project-name", ":")

        sources {
            // set up sources for all variants of all included projects
        }

        instrumentation {
            // set up instrumentation for all variants of all included projects
        }

        createVariant("variantName") {
            // create custom variant
        }
    }
}

abstract val merge: KoverMergingConfig(source)

Instance to configuring a merged report.

See details in merge.