Author: niallp
Date: Mon Feb 4 14:57:07 2008
New Revision: 618480
URL: http://svn.apache.org/viewvc?rev=618480&view=rev
Log:
Add Sandbox JIRA page generation
Added:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
(with props)
commons/sandbox/commons-build-plugin/src/site/xdoc/sandbox-jira-page-mojo.xml
(with props)
Modified:
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.build.xml
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.mojos.xml
commons/sandbox/commons-build-plugin/src/site/site.xml
commons/sandbox/commons-build-plugin/src/site/xdoc/generate-xdocs-build.xml
Added:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml?rev=618480&view=auto
==============================================================================
---
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
(added)
+++
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
Mon Feb 4 14:57:07 2008
@@ -0,0 +1,100 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: sandbox-issue-tracking-template.xml |
+ | (see commons-build-plugin/src/main/resources/commons-xdoc-templates) |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:jira-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.jira.componentid (required, numeric) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.jira.componentid>12311182</commons.jira.componentid> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>@NAME@ Issue tracking</title>
+ <author email="[EMAIL PROTECTED]">Commons Documentation Team</author>
+ </properties>
+ <body>
+
+ <section name="@NAME@ Issue tracking">
+ <p>
+ @NAME@ uses <a href="http://issues.apache.org/jira/";>ASF JIRA</a> for
for tracking issues.
+ See the <a href="http://issues.apache.org/jira/browse/SANDBOX";>Sandbox
JIRA project page</a>.
+ </p>
+
+ <p>
+ To use JIRA you may need to <a
href="http://issues.apache.org/jira/secure/Signup!default.jspa";>create an
account</a>
+ (if you have previously created/updated Commons issues using Bugzilla an
account will have been automatically
+ created and you can use the <a
href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa";>Forgot
Password</a>
+ page to get a new password).
+ </p>
+
+ <p>
+ If you would like to report a bug, or raise an enhancement request with
+ @NAME@ please do the following:
+ <ol>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&[EMAIL
PROTECTED]@&sorter/field=issuekey&sorter/order=DESC&status=1&status=4">Search
existing open bugs</a>.
+ If you find your issue listed then please add a comment with your
details.</li>
+ <li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
+ You may find your issue or idea has already been discussed.</li>
+ <li>Decide if your issue is a bug or an enhancement.</li>
+ <li>Submit either a <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310491&issuetype=1&priority=4&assignee=-1";>bug
report</a>
+ or <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310491&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
+ </ol>
+ </p>
+
+ <p>
+ Please also remember these points:
+ <ul>
+ <li>the more information you provide, the better we can help you</li>
+ <li>test cases are vital, particularly for any proposed
enhancements</li>
+ <li>the developers of @NAME@ are all unpaid volunteers</li>
+ </ul>
+ </p>
+
+ <p>
+ For more information on subversion and creating patches see the
+ <a href="http://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
+ </p>
+
+ <p>
+ You may also find these links useful:
+ <ul>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&[EMAIL
PROTECTED]@&sorter/field=issuekey&sorter/order=DESC&status=1&status=4">All
Open @NAME@ bugs</a></li>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&[EMAIL
PROTECTED]@&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All
Resolved @NAME@ bugs</a></li>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&[EMAIL
PROTECTED]@&sorter/field=issuekey&sorter/order=DESC">All @NAME@
bugs</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
Propchange:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Modified:
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.build.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.build.xml?rev=618480&r1=618479&r2=618480&view=diff
==============================================================================
---
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.build.xml
(original)
+++
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.build.xml
Mon Feb 4 14:57:07 2008
@@ -66,6 +66,42 @@
</target>
+ <!-- ========== Generate Sandbox Issue Tracking Page
====================== -->
+
+ <target name="sandbox-jira-page" description="Generate Sandbox JIRA Issue
Tracking page">
+
+ <echo level="${level}" message="----- commons:sandbox-jira-page -
Parameters - START -----" />
+ <echo level="${level}" message="project.name :
${project.name}" />
+ <echo level="${level}" message="commons.jira.componentid:
${commons.jira.componentid}" />
+ <echo level="${level}" message="----- commons:sandbox-jira-page -
Parameters - END -----" />
+
+ <echo level="info" message="*** Generating ${project.name} Sandbox
Issue Tracking Page ***" />
+
+ <!-- Create a temporary directory to load the template files into -->
+ <mkdir dir="${commonsMojoTempDir}"/>
+
+ <!-- Load the issue-tracking template from mojo resources to temp
directory -->
+ <loadresource property="sandbox-issuetracking-xml">
+ <javaresource
name="${commonsMojoXdocDir}/sandbox-issue-tracking-template.xml"/>
+ </loadresource>
+ <echo message="${sandbox-issuetracking-xml}"
file="${commonsMojoTempDir}/sandbox-issue-tracking-template.xml" append="false"
/>
+
+ <!-- Copy the issue-tracking template filtering to replace properties
-->
+ <copy file="${commonsMojoTempDir}/sandbox-issue-tracking-template.xml"
tofile="${commonsMojoTempDir}/issue-tracking.xml" overwrite="true">
+ <filterset>
+ <filter token="NAME" value="${project.name}"/>
+ <filter token="JIRA_COMPONENTID"
value="${commons.jira.componentid}"/>
+ </filterset>
+ </copy>
+
+ <!-- copy to either m1 or m2 xdoc directory -->
+ <antcall target="copy-to-xdoc-dir">
+ <param name="file.name" value="issue-tracking.xml"/>
+ </antcall>
+
+ </target>
+
+
<!-- ========== Generate Download Page
==================================== -->
<target name="download-page" description="Generate Download page">
Modified:
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.mojos.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.mojos.xml?rev=618480&r1=618479&r2=618480&view=diff
==============================================================================
---
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.mojos.xml
(original)
+++
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.mojos.xml
Mon Feb 4 14:57:07 2008
@@ -60,6 +60,32 @@
</parameters>
</mojo>
<mojo>
+ <goal>sandbox-jira-page</goal>
+ <call>sandbox-jira-page</call>
+ <description>Commons Build Ant Mojo: Generate Sandbox Issue
Tracking page</description>
+ <requiresProject>true</requiresProject>
+ <parameters>
+ <parameter>
+ <name>project.name</name>
+ <property>project.name</property>
+ <required>true</required>
+ <readonly>true</readonly>
+ <defaultValue>${project.name}</defaultValue>
+ <type>java.lang.String</type>
+ <description>The name of the project currently being
built.</description>
+ </parameter>
+ <parameter>
+ <name>commons.jira.componentid</name>
+ <property>commons.jira.componentid</property>
+ <required>true</required>
+ <readonly>false</readonly>
+ <defaultValue>${commons.jira.componentid}</defaultValue>
+ <type>java.lang.String</type>
+ <description>The internal JIRA component id
(numeric)</description>
+ </parameter>
+ </parameters>
+ </mojo>
+ <mojo>
<goal>download-page</goal>
<call>download-page</call>
<description>Commons Build Ant Mojo: Generate Download
page</description>
Modified: commons/sandbox/commons-build-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/site/site.xml?rev=618480&r1=618479&r2=618480&view=diff
==============================================================================
--- commons/sandbox/commons-build-plugin/src/site/site.xml (original)
+++ commons/sandbox/commons-build-plugin/src/site/site.xml Mon Feb 4 14:57:07
2008
@@ -26,8 +26,9 @@
<item name="Overview" href="/index.html"/>
<item name="Goals">
<item name="Generate XDOCS"
href="/generate-xdocs-build.html">
- <item name="jira-page"
href="/generate-xdocs-build.html#commons:jira-page"/>
+ <item name="jira-page"
href="/generate-xdocs-build.html"/>
<item name="download-page"
href="/generate-xdocs-build.html#commons:download-page"/>
+ <item name="sandbox-jira-page"
href="/generate-xdocs-build.html#commons:sandbox-jira-page"/>
</item>
<item name="copy-javadoc-files"
href="/copy-javadoc-files-build.html"/>
</item>
Modified:
commons/sandbox/commons-build-plugin/src/site/xdoc/generate-xdocs-build.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/site/xdoc/generate-xdocs-build.xml?rev=618480&r1=618479&r2=618480&view=diff
==============================================================================
--- commons/sandbox/commons-build-plugin/src/site/xdoc/generate-xdocs-build.xml
(original)
+++ commons/sandbox/commons-build-plugin/src/site/xdoc/generate-xdocs-build.xml
Mon Feb 4 14:57:07 2008
@@ -36,6 +36,7 @@
<ul>
<li><a href="#commons:jira-page">commons:jira-page</a> -
Generate a JIRA Issue Tracking page for a component</li>
<li><a href="#commons:download-page">commons:download-page</a>
- Generate a Download page for a component's latest release</li>
+ <li><a
href="#commons:sandbox-jira-page">commons:sandbox-jira-page</a> - Generate a
JIRA Issue Tracking page for a Sandbox component</li>
</ul>
</p>
@@ -85,8 +86,8 @@
<p>
To generate a JIRA page, the following <i>properties</i> are
configured in the component's <code>pom.xml</code>
<ul>
- <li><b>commons.jira.id</b> - JIRA's external (upper case)
id for the component</li>
- <li><b>commons.jira.pid</b> - JIRA's internal (numeric) id
for the component</li>
+ <li><b>commons.jira.id</b> - JIRA's external (upper case)
project id for the component</li>
+ <li><b>commons.jira.pid</b> - JIRA's internal (numeric)
project id for the component</li>
</ul>
</p>
<p>
@@ -151,6 +152,54 @@
<commons.componentid>chain</commons.componentid>
<commons.release.version>1.1</commons.release.version>
<commons.binary.suffix></commons.binary.suffix>
+ </properties>
+]]></source>
+ </p>
+ </subsection>
+
+ </section>
+
+
+ <section name="commons:sandbox-jira-page" href="jira-page">
+
+ <subsection name="Overview">
+ <p>
+ The <code>commons:sandbox-jira-page</code> goal generates a
custom JIRA Issue Tracking page for a <b>Sandbox</b> component.
+ Execute the goal using the following command: <source>mvn
commons:sandbox-jira-page</source>
+ </p>
+
+ <p>
+ <strong>Note:</strong> The Issue tracking page should only
need to be generated initially
+ for a component or if the issue tracking template changes.
+ </p>
+
+ <p>
+ This goal uses the following:
+ <ul>
+ <li>The goal is mapped to the ant script/target using the
<code>sandbox-jira-page</code> mojo defintion in the
+ <a
href="http://svn.apache.org/repos/asf/commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
+ <li>Executes the <code>sandbox-jira-page</code> target in
+ <a
href="http://svn.apache.org/repos/asf/commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a>
+ ant script</li>
+ <li>Uses the <a
href="http://svn.apache.org/repos/asf/commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml";>sandbox-issue-tracking-template.xml</a>
+ template</li>
+ <li>Uses the <a href="sandbox-jira-page-mojo.html">goal's
(i.e. mojo's) parameters</a> to filter values in the template</li>
+ </ul>
+ </p>
+ </subsection>
+
+ <subsection name="Configuration">
+ <p>
+ To generate a JIRA page, the following <i>properties</i> are
configured in the component's <code>pom.xml</code>
+ <ul>
+ <li><b>commons.jira.componentid</b> - JIRA's internal
(numeric) id for the component</li>
+ </ul>
+ </p>
+ <p>
+ Example configuration:
+<source><![CDATA[
+ <properties>
+ <commons.jira.componentid>12311182</commons.jira.componentid>
</properties>
]]></source>
</p>
Added:
commons/sandbox/commons-build-plugin/src/site/xdoc/sandbox-jira-page-mojo.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/site/xdoc/sandbox-jira-page-mojo.xml?rev=618480&view=auto
==============================================================================
---
commons/sandbox/commons-build-plugin/src/site/xdoc/sandbox-jira-page-mojo.xml
(added)
+++
commons/sandbox/commons-build-plugin/src/site/xdoc/sandbox-jira-page-mojo.xml
Mon Feb 4 14:57:07 2008
@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!--
+ $HeadURL$
+ $Revision$ $Date$
+ -->
+<document>
+ <properties>
+ <title>commons-build-plugin - commons:sandbox-jira-page</title>
+ </properties>
+ <body>
+ <section name="commons:sandbox-jira-page">
+ <p>Commons Build Ant Mojo: Generate Sandbox Issue Tracking page</p>
+ <p><b>Mojo Attributes</b>:<ul>
+ <li>Requires a Maven 2.0 project to execute.</li>
+ <li>Is NOT inherited by default in multi-project builds.</li>
+ </ul>
+ </p>
+ <subsection name="Required Parameters">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><b><a
href="#commons.jira.componentid">commons.jira.componentid</a></b></td>
+ <td><code>String</code></td>
+ <td>The internal JIRA component id (numeric) Default value is
<code>${commons.jira.componentid}</code>.</td>
+ </tr>
+ <tr>
+ <td><b><a href="#basedir">basedir</a></b></td>
+ <td><code>File</code></td>
+ <td>The base directory from which to execute the Ant script.
Default value is <code>${basedir}</code>.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Optional Parameters">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><b><a href="#messageLevel">messageLevel</a></b></td>
+ <td><code>String</code></td>
+ <td>The message-level used to tune the verbosity of Ant logging.
Default value is <code>info</code>.</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Parameter Details">
+ <p><b><a
name="commons.jira.componentid">commons.jira.componentid</a></b></p>
+ <p>The internal JIRA component id (numeric)</p>
+ <ul>
+ <li><b>Type</b>: <code>java.lang.String</code></li>
+ <li><b>Required</b>: <code>Yes</code></li>
+ <li><b>Default</b>: <code>${commons.jira.componentid}</code></li>
+ </ul><hr/><p><b><a name="basedir">basedir</a></b></p>
+ <p>The base directory from which to execute the Ant script.</p>
+ <ul>
+ <li><b>Type</b>: <code>java.io.File</code></li>
+ <li><b>Required</b>: <code>Yes</code></li>
+ <li><b>Expression</b>: <code>${antBasedir}</code></li>
+ <li><b>Default</b>: <code>${basedir}</code></li>
+ </ul><hr/><p><b><a name="messageLevel">messageLevel</a></b></p>
+ <p>The message-level used to tune the verbosity of Ant logging.</p>
+ <ul>
+ <li><b>Type</b>: <code>java.lang.String</code></li>
+ <li><b>Required</b>: <code>No</code></li>
+ <li><b>Expression</b>: <code>${antMessageLevel}</code></li>
+ <li><b>Default</b>: <code>info</code></li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+ </document>
Propchange:
commons/sandbox/commons-build-plugin/src/site/xdoc/sandbox-jira-page-mojo.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
commons/sandbox/commons-build-plugin/src/site/xdoc/sandbox-jira-page-mojo.xml
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
