The Build Dashboard Plugin is not compatible with the Configuration Cache. When the buildDashboard task is part of the build, the Configuration Cache is gracefully disabled for that build.

The Build Dashboard plugin can be used to generate a single HTML dashboard that provides a single point of access to all of the reports generated by a build.

Usage

To use the Build Dashboard plugin, include the following in your build script:

build.gradle.kts
plugins {
    `build-dashboard`
}
build.gradle
plugins {
    id 'build-dashboard'
}

Applying the plugin adds the buildDashboard task to your project. The task aggregates the reports for all tasks that implement the Reporting interface from all projects in the build. It is typically only applied to the root project.

The buildDashboard task does not depend on any other tasks. Instead, the plugin configures every reporting task in the build to be finalized by buildDashboard, so the dashboard is regenerated automatically after any reporting task runs. It will only aggregate the reporting tasks that are independently being executed as part of the build run. For example, “gradle buildDashboard build” will generate a dashboard for all of the reporting tasks that are dependents of the build task.

Tasks

The Build Dashboard plugin adds the following task to the project:

buildDashboard — GenerateBuildDashboard

Generates build dashboard report.

Project layout

The Build Dashboard plugin does not require any particular project layout.

Dependency management

The Build Dashboard plugin does not define any dependency configurations.

Configuration

By default, the dashboard is generated at layout.buildDirectory.dir("reports/buildDashboard"). You can influence the location of build dashboard generation via ReportingExtension.