Maven Dashboard aggregator creation guide Vincent Massol

The dashboard plugin supports custom aggregators. This page is a tutorial explaining how to create a custom aggregator.

An aggregator is a Jelly script that you plug in the dashboard plugin. This Jelly script is called on each Maven subproject to extract a single piece of data (ex: number of checkstyle errors, Clover test coverage percentage, etc).

The Jelly script must output the aggregator data for a project. For example:

]]>

Note that the Jelly script has access to all of the Dashboard plugin properties.

Add the following properties to your master project's project.properties:

In order to use your aggregator in the dashboard report, you need to add it to the list of aggregators by adding the following property in your project.properties:

If there is no existing goal that generates the data you need, create a custom goal in your top level maven.xml. Make sure your subprojects inherit from this top level project (so that maven.xml is inherited).

If you think your aggregator could be useful to others, feel free to donate it to the Maven project.