Author: niallp
Date: Thu Jan 31 19:50:37 2008
New Revision: 617341
URL: http://svn.apache.org/viewvc?rev=617341&view=rev
Log:
Number of changes:
- separate out JIRA page and download page generation into different goals
- cater for different binary distro suffixes
- cater for m1 and m2 xdoc locations
Added:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/download-page-template.xml
- copied, changed from r617279,
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/dowload-page-template.xml
Removed:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/dowload-page-template.xml
Modified:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
commons/sandbox/commons-build-plugin/src/main/scripts/copy-javadoc-files.build.xml
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.build.xml
commons/sandbox/commons-build-plugin/src/main/scripts/generate-xdocs.mojos.xml
Copied:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/download-page-template.xml
(from r617279,
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/dowload-page-template.xml)
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/download-page-template.xml?p2=commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/download-page-template.xml&p1=commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/dowload-page-template.xml&r1=617279&r2=617341&rev=617341&view=diff
==============================================================================
---
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/dowload-page-template.xml
(original)
+++
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/download-page-template.xml
Thu Jan 31 19:50:37 2008
@@ -16,12 +16,32 @@
limitations under the License.
-->
<!--
- ****************************************************************
- **** PLEASE NOTE: THIS FILE IS GENERATED BY THE COMMONS ****
- **** BUILD PLUGIN. DO NOT EDIT DIRECTLY ****
- **** ****
- **** To Re-generate use: mvn commons:generate-xdocs ****
- ****************************************************************
+ +----------------------------------------------------------------------+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +----------------------------------------------------------------------+
+ | TEMPLATE FILE: dowload-page-template.xml |
+ | (see commons-build-plugin/src/main/resources/commons-xdoc-templates) |
+ +----------------------------------------------------------------------+
+ | |
+ | 1) Re-generate using: mvn commons:download-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | - commons.binary.suffix (optional) |
+ | (defaults to "-bin", set to "" for pre-maven2 releases) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +----------------------------------------------------------------------+
-->
<document>
<properties>
@@ -82,17 +102,17 @@
<ul class="downloads">
<li class="group"><div class="links"><span
class="label">Binary</span></div>
<ul>
- <li class="download"><a href="[preferred]/commons/@ID@/binaries/@[EMAIL
PROTECTED]">@[EMAIL PROTECTED]</a>
+ <li class="download"><a
href="[preferred]/commons/@ID@/binaries/@FINAL_NAME@@[EMAIL PROTECTED]">@[EMAIL PROTECTED]</a>
<ul class="attributes">
- <li><span class="md5">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@[EMAIL PROTECTED]">md5</a>]</span>
- <span class="pgp">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@[EMAIL PROTECTED]">pgp</a>]</span>
+ <li><span class="md5">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@FINAL_NAME@@[EMAIL PROTECTED]">md5</a>]</span>
+ <span class="pgp">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@FINAL_NAME@@[EMAIL
PROTECTED]">pgp</a>]</span>
</li>
</ul>
</li>
- <li class="download"><a href="[preferred]/commons/@ID@/binaries/@[EMAIL
PROTECTED]">@[EMAIL PROTECTED]</a>
+ <li class="download"><a
href="[preferred]/commons/@ID@/binaries/@FINAL_NAME@@[EMAIL PROTECTED]">@[EMAIL PROTECTED]</a>
<ul class="attributes">
- <li><span class="md5">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@[EMAIL PROTECTED]">md5</a>]</span>
- <span class="pgp">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@[EMAIL PROTECTED]">pgp</a>]</span>
+ <li><span class="md5">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@FINAL_NAME@@[EMAIL PROTECTED]">md5</a>]</span>
+ <span class="pgp">[<a
href="http://www.apache.org/dist/commons/@ID@/binaries/@FINAL_NAME@@[EMAIL
PROTECTED]">pgp</a>]</span>
</li>
</ul>
</li>
Modified:
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml?rev=617341&r1=617340&r2=617341&view=diff
==============================================================================
---
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
(original)
+++
commons/sandbox/commons-build-plugin/src/main/resources/commons-xdoc-templates/issue-tracking-template.xml
Thu Jan 31 19:50:37 2008
@@ -16,12 +16,30 @@
limitations under the License.
-->
<!--
- ****************************************************************
- **** PLEASE NOTE: THIS FILE IS GENERATED BY THE COMMONS ****
- **** BUILD PLUGIN. DO NOT EDIT DIRECTLY ****
- **** ****
- **** To Re-generate use: mvn commons:generate-xdocs ****
- ****************************************************************
+ +----------------------------------------------------------------------+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +----------------------------------------------------------------------+
+ | TEMPLATE FILE: 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.id (required, alphabetic, upper case) |
+ | - commons.jira.pid (required, numeric) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.jira.id>MATH</commons.jira.id> |
+ | <commons.jira.pid>12310485</commons.jira.pid> |
+ | </properties> |
+ | |
+ +----------------------------------------------------------------------+
-->
<document>
<properties>
Modified:
commons/sandbox/commons-build-plugin/src/main/scripts/copy-javadoc-files.build.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/commons-build-plugin/src/main/scripts/copy-javadoc-files.build.xml?rev=617341&r1=617340&r2=617341&view=diff
==============================================================================
---
commons/sandbox/commons-build-plugin/src/main/scripts/copy-javadoc-files.build.xml
(original)
+++
commons/sandbox/commons-build-plugin/src/main/scripts/copy-javadoc-files.build.xml
Thu Jan 31 19:50:37 2008
@@ -24,9 +24,9 @@
<property name="commonsMojoId" value="Commons:javadoc-nl-copy" />
- <target name="copy-javadoc-files" description="Generate XDOC Pages">
+ <target name="copy-javadoc-files" description="Copy NOTICE/LICENSE files for
javadoc jar">
- <echo level="info" message="----- ${commonsMojoId} - Copying NOTICE and LICENSE files -----" />
+ <echo level="info" message="**** commons:copy-javadoc-files - Copying NOTICE
and LICENSE files ****" />
<!-- Copy pages, filtering parameter values -->
<copy todir="target/apidocs">
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=617341&r1=617340&r2=617341&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
Thu Jan 31 19:50:37 2008
@@ -20,61 +20,107 @@
$HeadURL$
$Revision$ $Date$
-->
-<project name="Commons Build: Standard XDOC Pages Generation" default="generate-xdocs"
basedir=".">
+<project name="Commons Build: Standard XDOC Pages Generation" default="init"
basedir=".">
<property name="commonsMojoId" value="Commons:xdoc-generate" />
<property name="commonsMojoXdocDir" value="resources/commons-xdoc-templates"
/>
<property name="commonsMojoTempDir" value="target/commons-generated-xdocs"
/>
<property name="level" value="debug" />
- <target name="generate-xdocs" description="Generate XDOC Pages">
+ <!-- ========== Generate Issue Tracking Page ==============================
-->
- <echo level="${level}" message="----- ${commonsMojoId} - Display Parameters - START -----" />
- <echo level="${level}" message="project.artifactId :
${project.artifactId}" />
- <echo level="${level}" message="project.version :
${project.version}" />
+ <target name="jira-page" description="Generate JIRA Issue Tracking page">
+
+ <echo level="${level}" message="----- commons:jira-page - Parameters - START
-----" />
<echo level="${level}" message="project.name : ${project.name}"
/>
- <echo level="${level}" message="commonsComponentId :
${commonsComponentId}" />
- <echo level="${level}" message="commonsReleaseVersion:
${commonsReleaseVersion}" />
- <echo level="${level}" message="commonsXdocsDir :
${commonsXdocsDir}" />
- <echo level="${level}" message="finalName : ${finalName}" />
- <echo level="${level}" message="commonsJiraId : ${commonsJiraId}"
/>
- <echo level="${level}" message="commonsJiraPid : ${commonsJiraPid}"
/>
- <echo level="${level}" message="----- ${commonsMojoId} - Display Parameters -
END -----" />
+ <echo level="${level}" message="commons.xdoc.dir :
${commons.xdoc.dir}" />
+ <echo level="${level}" message="commons.jira.id :
${commons.jira.id}" />
+ <echo level="${level}" message="commons.jira.pid :
${commons.jira.pid}" />
+ <echo level="${level}" message="----- commons:jira-page - Parameters - END
-----" />
- <echo level="info" message="----- ${commonsMojoId} - Generating standard xdoc pages -----" />
+ <echo level="info" message="*** Generating ${project.name} Issue Tracking Page
***" />
<!-- Create a temporary directory to load the template files into -->
<mkdir dir="${commonsMojoTempDir}"/>
- <!-- Copy the issue-tracking template from mojo resources to temp directory -->
+ <!-- Load the issue-tracking template from mojo resources to temp
directory -->
<loadresource property="issuetracking-xml">
<javaresource
name="${commonsMojoXdocDir}/issue-tracking-template.xml"/>
</loadresource>
- <echo message="${issuetracking-xml}"
file="${commonsMojoTempDir}/issue-tracking.xml" append="false" />
+ <echo message="${issuetracking-xml}"
file="${commonsMojoTempDir}/issue-tracking-template.xml" append="false" />
+
+ <!-- Copy the issue-tracking template filtering to replace properties
-->
+ <copy file="${commonsMojoTempDir}/issue-tracking-template.xml"
tofile="${commonsMojoTempDir}/issue-tracking.xml" overwrite="true">
+ <filterset>
+ <filter token="NAME" value="${project.name}"/>
+ <filter token="JIRA_ID" value="${commons.jira.id}"/>
+ <filter token="JIRA_PID" value="${commons.jira.pid}"/>
+ </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>
+
- <!-- Copy the dowload-page template from mojo resources to temp directory -->
+ <!-- ========== Generate Download Page ====================================
-->
+
+ <target name="download-page" description="Generate Download page">
+
+ <echo level="${level}" message="----- commons:download-page - Parameters -
START -----" />
+ <echo level="${level}" message="project.name : ${project.name}"
/>
+ <echo level="${level}" message="commons.componentid :
${commons.componentid}" />
+ <echo level="${level}" message="commons.release.version:
${commons.release.version}" />
+ <echo level="${level}" message="commons.release.name :
${commons.release.name}" />
+ <echo level="${level}" message="commons.binary.suffix :
${commons.binary.suffix}" />
+ <echo level="${level}" message="----- commons:download-page - Parameters - END
-----" />
+
+ <echo level="info" message="*** Generating ${project.name}
${commons.release.version} Download Page ***" />
+
+ <!-- Create a temporary directory to load the template files into -->
+ <mkdir dir="${commonsMojoTempDir}"/>
+
+ <!-- Load the dowload-page template from mojo resources to temp directory
-->
<loadresource property="downloadpage-xml">
- <javaresource
name="${commonsMojoXdocDir}/dowload-page-template.xml"/>
+ <javaresource
name="${commonsMojoXdocDir}/download-page-template.xml"/>
</loadresource>
- <echo message="${downloadpage-xml}"
file="${commonsMojoTempDir}/download_${commonsComponentId}.xml" append="false" />
-
+ <echo message="${downloadpage-xml}"
file="${commonsMojoTempDir}/download-page-template.xml" append="false" />
- <!-- Copy pages, filtering parameter values -->
- <copy todir="${commonsXdocsDir}">
- <fileset dir="${commonsMojoTempDir}" includes="*.xml">
- <include name="**/*.xml"/>
- </fileset>
+ <!-- Copy the download page template filtering to replace properties
-->
+ <copy file="${commonsMojoTempDir}/download-page-template.xml"
tofile="${commonsMojoTempDir}/download_${commons.componentid}.xml" overwrite="true">
<filterset>
- <filter token="ARTIFACT" value="${project.artifactId}"/>
- <filter token="NAME" value="${project.name}"/>
- <filter token="ID" value="${commonsComponentId}"/>
- <filter token="VERSION"
value="${commonsReleaseVersion}"/>
- <filter token="FINAL_NAME" value="${finalName}"/>
- <filter token="JIRA_PID" value="${commonsJiraPid}"/>
- <filter token="JIRA_ID" value="${commonsJiraId}"/>
+ <filter token="NAME" value="${project.name}"/>
+ <filter token="ID" value="${commons.componentid}"/>
+ <filter token="VERSION" value="${commons.release.version}"/>
+ <filter token="FINAL_NAME" value="${commons.release.name}"/>
+ <filter token="BINARY-SUFFIX" value="${commons.binary.suffix}"/>
</filterset>
</copy>
+ <!-- copy to either m1 or m2 xdoc directory -->
+ <antcall target="copy-to-xdoc-dir">
+ <param name="file.name"
value="download_${commons.componentid}.xml"/>
+ </antcall>
+ </target>
+
+ <target name="copy-to-xdoc-dir">
+ <available file="xdocs" type="dir"
property="m1.xdocs.lib.present"/>
+ <available file="src/site/xdoc" type="dir"
property="m2.xdocs.lib.present"/>
+ <antcall target="copy-to-m1-xdoc-dir"/>
+ <antcall target="copy-to-m2-xdoc-dir"/>
+ </target>
+
+ <target name="copy-to-m1-xdoc-dir" if="m1.xdocs.lib.present">
+ <echo level="info" message="*** Copying ${file.name} to m1 xdocs dir ***"
/>
+ <copy file="${commonsMojoTempDir}/${file.name}" tofile="xdocs/${file.name}"
overwrite="true" filtering="true"/>
+ </target>
+
+ <target name="copy-to-m2-xdoc-dir" if="m2.xdocs.lib.present">
+ <echo level="info" message="*** Copying ${file.name} to m2 src/site/xdoc dir
***" />
+ <copy file="${commonsMojoTempDir}/${file.name}" tofile="src/site/xdoc/${file.name}"
overwrite="true" filtering="true"/>
</target>
</project>
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=617341&r1=617340&r2=617341&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
Thu Jan 31 19:50:37 2008
@@ -25,29 +25,55 @@
<pluginMetadata>
<mojos>
<mojo>
- <goal>generate-xdocs</goal>
- <call>generate-xdocs</call>
- <description>Commons Build: Standard XDOC Pages Generation Ant
Mojo</description>
+ <goal>jira-page</goal>
+ <call>jira-page</call>
+ <description>Commons Build Ant Mojo: Generate Issue Tracking
page</description>
<requiresProject>true</requiresProject>
<parameters>
<parameter>
- <name>project.artifactId</name>
- <property>project.artifactId</property>
+ <name>project.name</name>
+ <property>project.name</property>
<required>true</required>
<readonly>true</readonly>
- <defaultValue>${project.artifactId}</defaultValue>
+ <defaultValue>${project.name}</defaultValue>
<type>java.lang.String</type>
- <description>The artifactId of the project currently being
built.</description>
+ <description>The name of the project currently being
built.</description>
</parameter>
<parameter>
- <name>project.version</name>
- <property>project.version</property>
+ <name>commons.jira.id</name>
+ <property>commons.jira.id</property>
<required>true</required>
- <readonly>true</readonly>
- <defaultValue>${project.version}</defaultValue>
+ <readonly>false</readonly>
+ <defaultValue>${commons.jira.id}</defaultValue>
+ <type>java.lang.String</type>
+ <description>The external JIRA id for the project (alphabetic,
upper case)</description>
+ </parameter>
+ <parameter>
+ <name>commons.jira.pid</name>
+ <property>commons.jira.pid</property>
+ <required>true</required>
+ <readonly>false</readonly>
+ <defaultValue>${commons.jira.pid}</defaultValue>
+ <type>java.lang.String</type>
+ <description>The internal JIRA id for the project
(numeric)</description>
+ </parameter>
+ <parameter>
+ <name>commons.xdoc.dir</name>
+ <property>commons.xdoc.dir</property>
+ <required>true</required>
+ <readonly>false</readonly>
+ <defaultValue>xdocs</defaultValue>
<type>java.lang.String</type>
- <description>The current version of the project currently being
built.</description>
+ <description>The site xdoc directory</description>
</parameter>
+ </parameters>
+ </mojo>
+ <mojo>
+ <goal>download-page</goal>
+ <call>download-page</call>
+ <description>Commons Build Ant Mojo: Generate Download
page</description>
+ <requiresProject>true</requiresProject>
+ <parameters>
<parameter>
<name>project.name</name>
<property>project.name</property>
@@ -58,58 +84,49 @@
<description>The name of the project currently being
built.</description>
</parameter>
<parameter>
- <name>commonsComponentId</name>
- <property>commonsComponentId</property>
+ <name>commons.componentid</name>
+ <property>commons.componentid</property>
<required>true</required>
<readonly>true</readonly>
- <defaultValue>${commonsComponentId}</defaultValue>
+ <defaultValue>${commons.componentid}</defaultValue>
<type>java.lang.String</type>
<description>The commons component id.</description>
</parameter>
<parameter>
- <name>commonsReleaseVersion</name>
- <property>commonsReleaseVersion</property>
+ <name>commons.release.version</name>
+ <property>commons.release.version</property>
<required>true</required>
<readonly>false</readonly>
- <defaultValue>${commonsReleaseVersion}</defaultValue>
+ <defaultValue>${commons.release.version}</defaultValue>
<type>java.lang.String</type>
<description>The version of the latest release of the
project.</description>
</parameter>
<parameter>
- <name>commonsXdocsDir</name>
- <property>commonsXdocsDir</property>
+ <name>commons.release.name</name>
+ <property>commons.release.name</property>
<required>true</required>
<readonly>false</readonly>
- <defaultValue>xdocs</defaultValue>
+
<defaultValue>${project.artifactId}-${commons.release.version}</defaultValue>
<type>java.lang.String</type>
- <description>The generated site directory</description>
- </parameter>
- <parameter>
- <name>commonsJiraId</name>
- <property>commonsJiraId</property>
- <required>true</required>
- <readonly>false</readonly>
- <defaultValue>${commonsJiraId}</defaultValue>
- <type>java.lang.String</type>
- <description>The external JIRA id for the project (upper
case)</description>
+ <description>The final name (i.e. artifactId-version) of the
artifacts being built.</description>
</parameter>
<parameter>
- <name>commonsJiraPid</name>
- <property>commonsJiraPid</property>
+ <name>commons.binary.suffix</name>
+ <property>commons.binary.suffix</property>
<required>true</required>
<readonly>false</readonly>
- <defaultValue>${commonsJiraPid}</defaultValue>
+ <defaultValue>${commons.binary.suffix}</defaultValue>
<type>java.lang.String</type>
- <description>The internal JIRA id for the project
(numeric)</description>
+ <description>The suffix for the binary
distro.</description>
</parameter>
<parameter>
- <name>finalName</name>
- <property>finalName</property>
+ <name>commons.xdoc.dir</name>
+ <property>commons.xdoc.dir</property>
<required>true</required>
<readonly>false</readonly>
-
<defaultValue>${project.artifactId}-${commonsReleaseVersion}</defaultValue>
+ <defaultValue>xdocs</defaultValue>
<type>java.lang.String</type>
- <description>The final name (i.e. artifactId-version) of the
artifacts being built.</description>
+ <description>The site xdoc directory</description>
</parameter>
</parameters>
</mojo>
