Chapter 30. The Build Dashboard Plugin

Table of Contents

30.1. Usage
30.2. Tasks
30.3. Project layout
30.4. Dependency management
30.5. Configuration

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 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.

30.1. Usage

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

Example 30.1. Using the Build Dashboard plugin

build.gradle

apply plugin: '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. It will only aggregate the reporting tasks that are independently being executed as part of the build run. To generate the build dashboard, simply include this task in the list of tasks to execute. For example, “gradle buildDashboard build” will generate a dashboard for all of the reporting tasks that are dependents of the build task.

30.2. Tasks

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

Table 30.1. Build Dashboard plugin - tasks

Task name Depends on Type Description

buildDashboard

-

GenerateBuildDashboard

Generates build dashboard report.

30.3. Project layout

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

30.4. Dependency management

The Build Dashboard plugin does not define any dependency configurations.

30.5. Configuration

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