You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by vm...@apache.org on 2004/04/30 11:05:49 UTC
cvs commit: maven-plugins/dashboard plugin.jelly
vmassol 2004/04/30 02:05:49
Modified: dashboard/src/plugin-test/subproject2 project.xml
project.properties
dashboard/xdocs navigation.xml goals.xml index.xml
changes.xml authoring.xml aggregators.xml
properties.xml
dashboard/src/plugin-test maven.xml project.properties
dashboard/src/plugin-test/subproject1 project.xml
project.properties
dashboard plugin.jelly
Log:
Updated plugin tests to verify we can generate the dashboard report by using the multiproject:site goal. Also updated documentation accordingly.
Revision Changes Path
1.3 +3 -1 maven-plugins/dashboard/src/plugin-test/subproject2/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/src/plugin-test/subproject2/project.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- project.xml 4 Mar 2004 18:03:25 -0000 1.2
+++ project.xml 30 Apr 2004 09:05:48 -0000 1.3
@@ -22,6 +22,8 @@
<id>test-maven-dashboard-plugin-subproject2</id>
<name>Maven Dashboard plugin test - Subproject2</name>
<reports>
- <report>maven-checkstyle-plugin</report>
+ <!-- Voluntarily do not put any report. We're forcing the execution
+ of artifact goals using the maven.dashboard.rungoals=true
+ property -->
</reports>
</project>
1.5 +1 -0 maven-plugins/dashboard/src/plugin-test/subproject2/project.properties
Index: project.properties
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/src/plugin-test/subproject2/project.properties,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- project.properties 4 Mar 2004 18:03:25 -0000 1.4
+++ project.properties 30 Apr 2004 09:05:48 -0000 1.5
@@ -22,3 +22,4 @@
maven.checkstyle.header.file = ${basedir}/../LICENSE.txt
maven.dashboard.aggregators = csall,cserrors,cswarnings,clovertpc,cloverloc,cloverncloc,junittests,junitpassrate,junitfailures,juniterrors
+maven.dashboard.rungoals = true
1.8 +1 -0 maven-plugins/dashboard/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/xdocs/navigation.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- navigation.xml 4 Mar 2004 18:03:26 -0000 1.7
+++ navigation.xml 30 Apr 2004 09:05:48 -0000 1.8
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
+
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
1.3 +1 -1 maven-plugins/dashboard/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/xdocs/goals.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- goals.xml 4 Mar 2004 18:03:26 -0000 1.2
+++ goals.xml 30 Apr 2004 09:05:48 -0000 1.3
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
+
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
@@ -16,7 +17,6 @@
* limitations under the License.
*/
-->
-
<document>
<properties>
1.5 +30 -20 maven-plugins/dashboard/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/xdocs/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 4 Mar 2004 18:03:26 -0000 1.4
+++ index.xml 30 Apr 2004 09:05:48 -0000 1.5
@@ -84,32 +84,42 @@
<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>
+ <subsection name="Solution 3: Using the multiproject plugin">
<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.
+ 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>
- 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>
+ Add the following 3 properties to your master project:
</p>
+<source><![CDATA[
+# Tells the dashboard plugin not to run its own reactor.
+# We'll use the one run by the multiproject.
+maven.dashboard.runreactor = false
+
+# (optional). Tells the dashboard not to specifically run
+# artifact goals (i.e. goals that generate artifacts that we aggregate
+# in the dashboard report). For example, if you already have defined
+# the reports generating these artifacts, you'd be better setting
+# rungoals to false so that the artifact goals are only run once.
+maven.dashboard.rungoals = false
+
+# Tells the multiproject plugin to execute the dashboard:report-single
+# goal on each project when you run it through multiproject:site.
+maven.multiproject.site.goals=site,dashboard:report-single
+]]></source>
<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.
+ Then generate the site by running the <code>multiproject:site</code>
+ goal.
</p>
+
</subsection>
</section>
</body>
1.18 +5 -0 maven-plugins/dashboard/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/xdocs/changes.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- changes.xml 28 Apr 2004 19:30:49 -0000 1.17
+++ changes.xml 30 Apr 2004 09:05:48 -0000 1.18
@@ -28,6 +28,11 @@
<release version="1.3" date="in CVS">
<action dev="vmassol" type="update">
+ Updated plugin tests to verify we can generate the dashboard
+ report by using the multiproject:site goal. Also updated documentation
+ accordingly.
+ </action>
+ <action dev="vmassol" type="update">
Removed explicit dependencies on <code>maven-clover-plugin</code> and
<code>maven-junit-report-plugin</code>. The reason I've removed the
dependencies is that people will want to use different versions of
1.5 +1 -0 maven-plugins/dashboard/xdocs/authoring.xml
Index: authoring.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/xdocs/authoring.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- authoring.xml 4 Mar 2004 18:03:26 -0000 1.4
+++ authoring.xml 30 Apr 2004 09:05:48 -0000 1.5
@@ -1,4 +1,5 @@
<?xml version="1.0"?>
+
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
1.6 +1 -0 maven-plugins/dashboard/xdocs/aggregators.xml
Index: aggregators.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/xdocs/aggregators.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- aggregators.xml 4 Mar 2004 18:03:26 -0000 1.5
+++ aggregators.xml 30 Apr 2004 09:05:48 -0000 1.6
@@ -1,4 +1,5 @@
<?xml version="1.0"?>
+
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
1.5 +1 -1 maven-plugins/dashboard/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/xdocs/properties.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- properties.xml 4 Mar 2004 18:03:26 -0000 1.4
+++ properties.xml 30 Apr 2004 09:05:48 -0000 1.5
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
+
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
@@ -16,7 +17,6 @@
* limitations under the License.
*/
-->
-
<document>
<properties>
1.6 +2 -1 maven-plugins/dashboard/src/plugin-test/maven.xml
Index: maven.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/src/plugin-test/maven.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- maven.xml 4 Mar 2004 18:03:25 -0000 1.5
+++ maven.xml 30 Apr 2004 09:05:48 -0000 1.6
@@ -34,7 +34,8 @@
<attainGoal name="multiproject:goal"/>
<!-- Call goal to test -->
- <attainGoal name="site"/>
+ <j:set var="maven.multiproject.site.goals" value="site,dashboard:report-single"/>
+ <attainGoal name="multiproject:site"/>
</goal>
1.7 +5 -0 maven-plugins/dashboard/src/plugin-test/project.properties
Index: project.properties
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/src/plugin-test/project.properties,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- project.properties 2 Apr 2004 19:54:07 -0000 1.6
+++ project.properties 30 Apr 2004 09:05:48 -0000 1.7
@@ -28,3 +28,8 @@
maven.multiproject.basedir=${basedir}
maven.multiproject.includes=*/project.xml
maven.multiproject.excludes=
+
+# Turn off these properties are we're using the multiproject plugin to
+# generate the dashboard
+maven.dashboard.rungoals = false
+maven.dashboard.runreactor = false
1.4 +1 -0 maven-plugins/dashboard/src/plugin-test/subproject1/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/src/plugin-test/subproject1/project.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- project.xml 2 Apr 2004 03:48:30 -0000 1.3
+++ project.xml 30 Apr 2004 09:05:49 -0000 1.4
@@ -36,5 +36,6 @@
<reports>
<report>maven-checkstyle-plugin</report>
<report>maven-clover-plugin</report>
+ <report>maven-junit-report-plugin</report>
</reports>
</project>
1.5 +2 -0 maven-plugins/dashboard/src/plugin-test/subproject1/project.properties
Index: project.properties
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/src/plugin-test/subproject1/project.properties,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- project.properties 4 Mar 2004 18:03:25 -0000 1.4
+++ project.properties 30 Apr 2004 09:05:49 -0000 1.5
@@ -22,3 +22,5 @@
maven.checkstyle.header.file = ${basedir}/../LICENSE.txt
maven.dashboard.aggregators = csall,cserrors,cswarnings,clovertpc,cloverloc,cloverncloc,junittests,junitpassrate,junitfailures,juniterrors
+
+maven.clover.report.xml = true
1.9 +29 -27 maven-plugins/dashboard/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/maven-plugins/dashboard/plugin.jelly,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- plugin.jelly 13 Mar 2004 21:34:21 -0000 1.8
+++ plugin.jelly 30 Apr 2004 09:05:49 -0000 1.9
@@ -185,31 +185,32 @@
========================================================================
-->
<goal name="dashboard:run-goals">
-
- <!-- Make sure that the Clover plugin generates only the XML report (as
- this is report used by the Clover aggregators to extract information
- from). The reason we disable the other reports is to win some response
- time. -->
- <j:set var="cloverReportXml"
- value="${pom.getVariable('maven.clover.report.xml')}"/>
- <j:set var="maven.clover.report.xml" value="true" scope="parent"/>
- <j:set var="cloverReportHtml"
- value="${pom.getVariable('maven.clover.report.html')}"/>
- <j:set var="maven.clover.report.html" value="false" scope="parent"/>
- <j:set var="cloverReportSwing"
- value="${pom.getVariable('maven.clover.report.swing')}"/>
- <j:set var="maven.clover.report.swing" value="false" scope="parent"/>
-
- <u:tokenize var="aggregatorNames" delim=",">${maven.dashboard.aggregators}</u:tokenize>
-
- <!-- Property used to remember what goals have already been called -->
- <j:set var="executedGoals" value=""/>
<!-- For each report, call the goal associated with the report type so that
raw data for that report type are generated. For example the checkstyle
report type will call checkstyle:checkstyle -->
<j:set var="rungoals" value="${maven.dashboard.rungoals}"/>
<j:if test="${rungoals == 'true'}">
+
+ <!-- Make sure that the Clover plugin generates only the XML report (as
+ this is report used by the Clover aggregators to extract information
+ from). The reason we disable the other reports is to win some response
+ time. -->
+ <j:set var="cloverReportXml"
+ value="${pom.getVariable('maven.clover.report.xml')}"/>
+ <j:set var="maven.clover.report.xml" value="true" scope="parent"/>
+ <j:set var="cloverReportHtml"
+ value="${pom.getVariable('maven.clover.report.html')}"/>
+ <j:set var="maven.clover.report.html" value="false" scope="parent"/>
+ <j:set var="cloverReportSwing"
+ value="${pom.getVariable('maven.clover.report.swing')}"/>
+ <j:set var="maven.clover.report.swing" value="false" scope="parent"/>
+
+ <u:tokenize var="aggregatorNames" delim=",">${maven.dashboard.aggregators}</u:tokenize>
+
+ <!-- Property used to remember what goals have already been called -->
+ <j:set var="executedGoals" value=""/>
+
<j:forEach var="aggregatorName" items="${aggregatorNames}">
<a:echo>Generating data for aggregator [${aggregatorName}]</a:echo>
@@ -242,15 +243,16 @@
</j:if>
</j:forEach>
- </j:if>
- <!-- Restore Clover plugin properties -->
- <j:set var="maven.clover.report.xml" value="${cloverReportXml}"
- scope="parent"/>
- <j:set var="maven.clover.report.html" value="${cloverReportHtml}"
- scope="parent"/>
- <j:set var="maven.clover.report.swing" value="${cloverReportSwing}"
- scope="parent"/>
+ <!-- Restore Clover plugin properties -->
+ <j:set var="maven.clover.report.xml" value="${cloverReportXml}"
+ scope="parent"/>
+ <j:set var="maven.clover.report.html" value="${cloverReportHtml}"
+ scope="parent"/>
+ <j:set var="maven.clover.report.swing" value="${cloverReportSwing}"
+ scope="parent"/>
+
+ </j:if>
</goal>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org