Maven Dashboard Report

The Dashboard plugin generates a quick overview over the report information available on the project.

The information of all reports is collected and shown in a single table. The table contains a row for each (sub) module. Each statistic is shown in a column. This implementation resembles the Maven 1 dashboard plugin.

The following reports are currently supported:

Goals Overview

This plugin has a reporting goal and a build goal:

  • The dashboard:report goal generates a dummy report, that will be replaced by the dashboard:dashboard goal. This page will be linked in the Project Reports menu.
  • The dashboard:dashboard goal is the main goal of this plugin. It will collect the statistics from the reports configured for the project and display them in single table. By default the table will be appended to the index.html page. This MOJO can be configured to append the table to any file and any (X)HTML tag in that file, by using XPath.

Usage

Instructions on how to use the Maven Dashboard Plugin can be found here .

Examples

  • Configure the Dashboard plugin to run as a report - This example explains how you can configure this plugin to append the dashboard table to the report page created by the reporting goal. This configuration will not change the index.html, which is the default behaviour of the plugin.
  • Customize the Dashboard table - This example explains how to customize the dashboard table to include the statistics you want.
  • Create a Dashboard Report - This example explains how to extend the plugin by a new dashboard report. The statistics will be added to the dashboard table.