Chapter 48. The Build Dashboard Plugin

The build dashboard plugin is currently incubating. Please be aware that the DSL and other configuration may change in later Gradle versions.

The Build Dashboard plugin adds a task to projects which generates build dashboard report.

48.1. Usage

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

Example 48.1. Using the Build Dashboard plugin

build.gradle

apply plugin: 'build-dashboard'

You can then generate the report by running the buildDashboard together with any tasks that generate reports, for example: gradle buildDashboard check. Because buildDashboard task is always set to run after all of the Reporting tasks that were added to the task graph the report will reference all reports generated by those tasks.

48.2. Tasks

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

Table 48.1. Build Dashboard plugin - tasks

Task name	Depends on	Type	Description
`buildDashboard`	-	`GenerateBuildDashboard`	Generates build dashboard report.

48.3. Project layout

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

48.4. Dependency management

The Build Dashboard plugin does not define any dependency configurations.

48.5. Configuration

You can influence the location of build dashboard plugin generation via ReportingExtension.