df5131d5d1
- Added several other aggregators - Do not run report artifact goal if it has already been run by a previous aggregator git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114266 13f79535-47bb-0310-9956-ffa450edef68
94 lines
3.5 KiB
XML
94 lines
3.5 KiB
XML
<?xml version="1.0"?>
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven Dashboard plugin</title>
|
|
<author email="vmassol@apache.org">Vincent Massol</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Maven Dashboard plugin">
|
|
<p>
|
|
Generate a dashboard HTML report containing information gathered
|
|
from other Maven reports (Checkstyle, Clover, JUnit, Simian, etc).
|
|
The dashboard aggregate this information for all subprojects,
|
|
presenting them in a single tabular format.
|
|
</p>
|
|
<p>
|
|
Current features:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
Pluggable architecture. It allows to add custom aggregators for any
|
|
kind of report, be them Maven reports or anything else (like
|
|
calling an SCM system, calling JIRA, etc). An aggregator is actually
|
|
a Jelly script so that you have the full power of Jelly at your hand.
|
|
</li>
|
|
<li>
|
|
Provides <a href="aggregators.html">default aggregators</a>.
|
|
</li>
|
|
<li>
|
|
Allows tight integration in one's own custom reactor and prevents
|
|
running reports several times.
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section name="Quick start">
|
|
<p>
|
|
There are several possible ways of using the dashboard plugin.
|
|
</p>
|
|
<subsection name="Solution 1: Registering it as a Maven report">
|
|
<p>
|
|
In your master project, add a <code>maven-dashboard-report</code>
|
|
report entry:
|
|
</p>
|
|
<source><![CDATA[
|
|
<reports>
|
|
[...]
|
|
<report>maven-dashboard-plugin</report>
|
|
</reports>
|
|
]]></source>
|
|
<p>
|
|
Then, when you generate the web site (<code>maven site</code>),
|
|
Maven will generate the dashboard report which will be available
|
|
in the web site left menu, under "Project Reports".
|
|
</p>
|
|
</subsection>
|
|
<subsection name="Solution 2: Running it manually">
|
|
<p>
|
|
In your master project, simply type <code>maven dashboard</code>.
|
|
This will generate a dashboard xdoc file. Then type
|
|
<code>maven xdoc</code> to transform it into an HTML file.
|
|
</p>
|
|
</subsection>
|
|
<subsection name="Solution 3: Including it in a custom reactor">
|
|
<p><strong>
|
|
Only use this solution if you're already familiar with the
|
|
dashboard plugin.
|
|
</strong></p>
|
|
<p>
|
|
If you are already running a custom reactor you have the possibility
|
|
to integrate the dashboard plugin in your reactor build. You would
|
|
do this to shorten the build time.
|
|
</p>
|
|
<p>
|
|
To do this, you need to add the <code>dashboard:report-single</code>
|
|
goal to the list of goals being run by your reactor. The best option
|
|
is to ensure this goal is run after the other goals generating the
|
|
report artifacts needed by the dashboard aggregators you're running.
|
|
In order to prevent the <code>dashboard:report-single</code> goal from
|
|
automatically calling the report artifact goals, you'll need to add
|
|
the following property: <code>maven.dashboard.rungoals = false</code>.
|
|
</p>
|
|
<p>
|
|
At the master project level, you'll simply need to add a report entry
|
|
as described above in 'Solution 1'. You'll also need to add the
|
|
following property: <code>maven.dashboard.runreactor = false</code>.
|
|
This property prevents the dashboard plugin from automatically calling
|
|
the dashboard reactor.
|
|
</p>
|
|
</subsection>
|
|
</section>
|
|
</body>
|
|
</document>
|