Repository: commons-release-plugin Updated Branches: refs/heads/master e46ed7dc6 -> 78348557a
[COMMONSSITE-112][release-plugin] should create a VOTE.txt file. Project: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/commit/78348557 Tree: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/tree/78348557 Diff: http://git-wip-us.apache.org/repos/asf/commons-release-plugin/diff/78348557 Branch: refs/heads/master Commit: 78348557aad6200a51c1ba7c76ed915790d0583a Parents: e46ed7d Author: Gary Gregory <[email protected]> Authored: Mon May 14 17:02:10 2018 -0600 Committer: Gary Gregory <[email protected]> Committed: Mon May 14 17:02:10 2018 -0600 ---------------------------------------------------------------------- pom.xml | 31 +++- .../vote-txt-template.txt | 109 +++++++++++ src/main/scripts/generate-xdocs.build.xml | 95 ++++++++++ src/main/scripts/generate-xdocs.mojos.xml | 180 +++++++++++++++++++ src/site/xdoc/vote-txt-mojo.xml | 45 +++++ src/site/xdoc/vote-txt.xml | 77 ++++++++ 6 files changed, 534 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/78348557/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 157a378..82c9df7 100644 --- a/pom.xml +++ b/pom.xml @@ -106,7 +106,7 @@ <project.reporting.outputEncoding>${commons.encoding}</project.reporting.outputEncoding> </properties> - <dependencies> + <dependencies> <dependency> <groupId>org.apache.maven</groupId> <artifactId>maven-core</artifactId> @@ -157,7 +157,7 @@ <groupId>org.apache.commons</groupId> <artifactId>commons-compress</artifactId> <version>1.16.1</version> - </dependency> + </dependency> <dependency> <groupId>org.apache.maven.plugin-testing</groupId> <artifactId>maven-plugin-testing-harness</artifactId> @@ -176,6 +176,12 @@ <version>4.12</version> <scope>test</scope> </dependency> + <!-- A bit of jar-hell requires this to come last. --> + <dependency> + <groupId>org.apache.maven</groupId> + <artifactId>maven-script-ant</artifactId> + <version>2.2.1</version> + </dependency> </dependencies> <build> @@ -212,10 +218,29 @@ </plugins> </pluginManagement> <plugins> + + <plugin> + <artifactId>maven-plugin-plugin</artifactId> + <version>3.5.1</version> + <!-- Add the Ant plugin tools to the plugin --> + <dependencies> + <dependency> + <groupId>org.apache.maven.plugin-tools</groupId> + <artifactId>maven-plugin-tools-ant</artifactId> + <version>3.5.1</version> + </dependency> + </dependencies> + + <configuration> + <goalPrefix>commons-release</goalPrefix> + </configuration> + + </plugin> + <plugin> <groupId>org.apache.commons</groupId> <artifactId>commons-build-plugin</artifactId> - <version>1.7</version> + <version>1.8</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/78348557/src/main/resources/commons-xdoc-templates/vote-txt-template.txt ---------------------------------------------------------------------- diff --git a/src/main/resources/commons-xdoc-templates/vote-txt-template.txt b/src/main/resources/commons-xdoc-templates/vote-txt-template.txt new file mode 100644 index 0000000..5bec19c --- /dev/null +++ b/src/main/resources/commons-xdoc-templates/vote-txt-template.txt @@ -0,0 +1,109 @@ +<!-- + 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. +--> +*** THESE ITEMS REQUIRED YOUR ATTENTION *** +To: [email protected] +Subject: [VOTE] Release @NAME@ @VERSION@ based on @RC@ + +We have fixed quite a few bugs and added some significant enhancements since @NAME@ @BC@ was released, so I would like to release @NAME@ @VERSION@. + +@NAME@ @VERSION@ @RC@ is available for review here: + https://dist.apache.org/repos/dist/dev/commons/@ROOTID@/@ARTIFACTID@-@VERSION@-@RC@ (svn revision @RCREV@) + +The Subversion tag for this RC is here: + http://svn.apache.org/repos/asf/commons/proper/@ROOTID@/tags/@ARTIFACTID@-@VERSION@-@RC@/ (svn revision XYZ2) + N.B. the SVN revision is required because SVN tags are not immutable. +***OR*** +The Git tag for this RC is here: + https://git-wip-us.apache.org/repos/asf?p=@[email protected];a=tag;h=refs/tags/@ARTIFACTID@-@VERSION@-@RC@ + +Maven artifacts are here: + https://repository.apache.org/content/repositories/orgapachecommons-***NNNN***/org/apache/commons/@ARTIFACTID@/@VERSION@/ + +These are the Maven artifacts and their hashes in Nexus: + +*** +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) +/org/apache/commons/@ARTIFACTID@/@VERSION@/@ARTIFACTID@-@[email protected] +(SHA1: ***DEADBEEF***) + +(no need for .asc hashes!) + +I have tested this with ***'mvn clean install site'*** using: +*** +Use the output from "mvn -version" for each combination you tested. +*** + +Details of changes since @BC@ are in the release notes: + https://dist.apache.org/repos/dist/dev/commons/@ROOTID@/@VERSION@-@RC@/RELEASE-NOTES.txt + https://dist.apache.org/repos/dist/dev/commons/@ROOTID@/@VERSION@-@RC@/site/changes-report.html + +Site: + https://dist.apache.org/repos/dist/dev/commons/@ROOTID@/@VERSION@-@RC@/site + (note some *relative* links are broken and the @VERSION@ directories are not yet created - these will be OK once the site is deployed.) + +CLIRR OR JaCoCo Report (compared to @BC@): + https://dist.apache.org/repos/dist/dev/commons/@ROOTID@/@VERSION@-@RC@/site/clirr-report.html + + *** + Note that Clirr reports several errors. + These are considered OK for the reasons stated below. + These exceptions are also noted in the Changes and Release Notes. + + Errors reported: + - methods added to interface: OK because that does not affect binary compatibility. + - etc. + *** + +RAT Report: + https://dist.apache.org/repos/dist/dev/commons/@ROOTID@/@VERSION@-@RC@/site/rat-report.html + +KEYS: + https://www.apache.org/dist/commons/KEYS + +Please review the release candidate and vote. +This vote will close no sooner that 72 hours from now. + + [ ] +1 Release these artifacts + [ ] +0 OK, but... + [ ] -0 OK, but really should fix... + [ ] -1 I oppose this release because... + +Thank you, + +@RMNAME@, +Release Manager (using key @RMKEY@) http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/78348557/src/main/scripts/generate-xdocs.build.xml ---------------------------------------------------------------------- diff --git a/src/main/scripts/generate-xdocs.build.xml b/src/main/scripts/generate-xdocs.build.xml new file mode 100644 index 0000000..3e0d1f9 --- /dev/null +++ b/src/main/scripts/generate-xdocs.build.xml @@ -0,0 +1,95 @@ +<!-- + 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. +--> +<!-- + Commons Build: Standard XDOC Pages Generation. + --> +<project name="Commons Release: Standard XDOC Pages Generation" 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="info" /> + + + <!-- ========== Generate VOTE.txt file ================================ --> + + <target name="vote-txt" description="Generates VOTE.txt"> + + <echo level="${level}" message="----- commons:vote-txt - Parameters - START -----" /> + <echo level="${level}" message="project.name : ${project.name}" /> + <echo level="${level}" message="project.artifactId : ${project.artifactId}" /> + <echo level="${level}" message="project.groupId : ${project.groupId}" /> + <echo level="${level}" message="commons.jira.id : ${commons.jira.id}" /> + <echo level="${level}" message="commons.release.version : ${commons.release.version}" /> + <echo level="${level}" message="commons.rc.version : ${commons.rc.version}" /> + <echo level="${level}" message="commons.bc.version : ${commons.bc.version}" /> + <echo level="${level}" message="commons.componentrootid : ${commons.componentrootid}" /> + <echo level="${level}" message="commons.componentid : ${commons.componentid}" /> + <echo level="${level}" message="commons.releaseManagerName : ${commons.releaseManagerName}" /> + <echo level="${level}" message="commons.releaseManagerKey : ${commons.releaseManagerKey}" /> + <echo level="${level}" message="----- commons:vote-txt - Parameters - END -----" /> + + <echo level="info" message="*** Generating ${project.name} VOTE.txt ***" /> + + <!-- Create a temporary directory to load the template files into --> + <mkdir dir="${commonsMojoTempDir}"/> + + <!-- Load the vote-txt template from mojo resources to temp directory --> + <loadresource property="vote-txt"> + <javaresource name="${commonsMojoXdocDir}/vote-txt-template.txt"/> + </loadresource> + <echo message="${vote-txt}" file="${commonsMojoTempDir}/vote-txt-template.txt" append="false" /> + + <!-- Without using ant-contrib: remove "-project" for multi-module artifacts --> + <loadresource property="tmp.artifactId"> + <propertyresource name="project.artifactId" /> + <filterchain> + <tokenfilter> + <filetokenizer/> + <replacestring from="-project" to=""/> + </tokenfilter> + </filterchain> + </loadresource> + + <exec executable="svn" outputproperty="svn.rc.revision"> + <arg line="info https://dist.apache.org/repos/dist/dev/commons/${commons.componentrootid}/${commons.release.version}-${commons.rc.version} --show-item revision" /> + </exec> + <echo level="${level}" message="svn.rc.revision : ${svn.rc.revision}" /> + + <!-- Copy the vote-txt template filtering to replace properties --> + <copy file="${commonsMojoTempDir}/vote-txt-template.txt" tofile="VOTE.txt" overwrite="true"> + <filterset> + <filter token="NAME" value="${project.name}"/> + <filter token="ARTIFACTID" value="${project.artifactId}"/> + <filter token="ARTIFACTCOREID" value="${tmp.artifactId}"/> + <filter token="GROUPID" value="${project.groupId}"/> + <filter token="JIRA_ID" value="${commons.jira.id}"/> + <filter token="VERSION" value="${commons.release.version}"/> + <filter token="RC" value="${commons.rc.version}"/> + <filter token="BC" value="${commons.bc.version}"/> + <filter token="DESCRIPTION" value="${project.description}"/> + <filter token="ID" value="${commons.componentid}"/> + <filter token="ROOTID" value="${commons.componentrootid}"/> + <filter token="RMNAME" value="${commons.releaseManagerName}"/> + <filter token="RMKEY" value="${commons.releaseManagerKey}"/> + <filter token="RCREV" value="${svn.rc.revision}"/> + </filterset> + </copy> + + </target> + +</project> http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/78348557/src/main/scripts/generate-xdocs.mojos.xml ---------------------------------------------------------------------- diff --git a/src/main/scripts/generate-xdocs.mojos.xml b/src/main/scripts/generate-xdocs.mojos.xml new file mode 100644 index 0000000..ec9f436 --- /dev/null +++ b/src/main/scripts/generate-xdocs.mojos.xml @@ -0,0 +1,180 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + + 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. +--> +<!-- + Mojo metadata for "Commons Build: Standard XDOC Pages Generation". +--> +<pluginMetadata + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns="http://maven.apache.org/PLUGIN-METADATA/1.1.0"; + xsi:schemaLocation="http://maven.apache.org/PLUGIN-METADATA/1.1.0 http://maven.apache.org/xsd/plugin-metadata-1.1.0.xsd";> + <mojos> + <mojo> + <goal>vote-txt</goal> + <call>vote-txt</call> + <description>Apache Commons Release Mojo: Generate VOTE.txt file.</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>project.groupId</name> + <property>project.groupId</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${project.groupId}</defaultValue> + <type>java.lang.String</type> + <description>The groupId of the project currently being built.</description> + </parameter> + <parameter> + <name>project.artifactId</name> + <property>project.artifactId</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${project.artifactId}</defaultValue> + <type>java.lang.String</type> + <description>The artifactId of the project currently being built.</description> + </parameter> + <parameter> + <name>commons.jira.id</name> + <property>commons.jira.id</property> + <required>true</required> + <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.componentrootid</name> + <property>commons.componentrootid</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${commons.componentrootid}</defaultValue> + <type>java.lang.String</type> + <description>The commons component root id.</description> + </parameter> + <parameter> + <name>commons.componentid</name> + <property>commons.componentid</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${commons.componentid}</defaultValue> + <type>java.lang.String</type> + <description>The commons component id.</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.rc.version</name> + <property>commons.rc.version</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.rc.version}</defaultValue> + <type>java.lang.String</type> + <description>The version of the latest release candidate of the project.</description> + </parameter> + <parameter> + <name>commons.bc.version</name> + <property>commons.bc.version</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.bc.version}</defaultValue> + <type>java.lang.String</type> + <description>The version of the latest release of the project this candidate should have binary compatibility.</description> + </parameter> + <parameter> + <name>commons.release.version</name> + <property>commons.release.version</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.release.version}</defaultValue> + <type>java.lang.String</type> + <description>The version of the latest release of the project.</description> + </parameter> + <parameter> + <name>commons.release.name</name> + <property>commons.release.name</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.release.name}</defaultValue> + <type>java.lang.String</type> + <description>The name of the latest release of the project.</description> + </parameter> + <parameter> + <name>commons.binary.suffix</name> + <property>commons.binary.suffix</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.binary.suffix}</defaultValue> + <type>java.lang.String</type> + <description>The suffix for the binary distribution.</description> + </parameter> + <parameter> + <name>commons.release.desc</name> + <property>commons.release.desc</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.desc}</defaultValue> + <type>java.lang.String</type> + <description>Release Title or Description.</description> + </parameter> + <parameter> + <name>commons.release.subdir</name> + <property>commons.release.subdir</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.subdir}</defaultValue> + <type>java.lang.String</type> + <description>Subdirectory (instead of source/binaries.)</description> + </parameter> + <parameter> + <name>commons.releaseManagerName</name> + <property>commons.releaseManagerName</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.releaseManagerName}</defaultValue> + <type>java.lang.String</type> + <description>Release manager name.</description> + </parameter> + <parameter> + <name>commons.releaseManagerKey</name> + <property>commons.releaseManagerKey</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.releaseManagerKey}</defaultValue> + <type>java.lang.String</type> + <description>Release manager key.</description> + </parameter> + </parameters> + </mojo> + </mojos> +</pluginMetadata> http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/78348557/src/site/xdoc/vote-txt-mojo.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/vote-txt-mojo.xml b/src/site/xdoc/vote-txt-mojo.xml new file mode 100644 index 0000000..e922a1b --- /dev/null +++ b/src/site/xdoc/vote-txt-mojo.xml @@ -0,0 +1,45 @@ +<?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. +--> +<document> + <properties> + <title>commons:vote-txt</title> + </properties> + <body> + <section name="commons:vote-txt"> + <p><strong>Full name</strong>:</p> + <p>org.apache.commons:commons-release-plugin:1.3:vote-txt</p> + <p><strong>Description</strong>:</p> + <div>Apache Commons Release Mojo: Generate VOTE.txt</div> + <p><strong>Attributes</strong>:</p> + <ul> + <li>Requires a Maven 2.0 project to be executed.</li> + <li>Is NOT inherited by default in multi-project builds.</li> + </ul> + <subsection name="Required Parameters"> + <table border="0" align="left"> + </table> + </subsection> + <subsection name="Optional Parameters"> + <table border="0" align="left"> + </table> + </subsection> + <subsection name="Parameter Details"> + </subsection> + </section> + </body> +</document> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/commons-release-plugin/blob/78348557/src/site/xdoc/vote-txt.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/vote-txt.xml b/src/site/xdoc/vote-txt.xml new file mode 100644 index 0000000..d4fb0dc --- /dev/null +++ b/src/site/xdoc/vote-txt.xml @@ -0,0 +1,77 @@ +<?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. +--> +<document> + + <properties> + <title>Generating VOTE.txt</title> + <author email="[email protected]">Apache Commons Documentation Team</author> + </properties> + + <body> + + + <section name="commons-release:vote-txt" href="vote-txt"> + + <subsection name="Overview"> + <p> + The <code>commons-release:vote-txt</code> goal generates a VOTE.txt file for a component. + Execute the goal using the following command: <source>mvn commons-release:vote-txt</source> + </p> + + <p> + <strong>Note:</strong> The VOTE.txt should be regenerated before every release candidate. + </p> + + <p> + This goal uses the following: + <ul> + <li>The goal is mapped to the ant script/target using the <code>vote-txt</code> mojo defintion in the + <a href="http://svn.apache.org/repos/asf/commons/proper/commons-release-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a> mapping document</li> + <li>Executes the <code>vote-txt</code> target in + <a href="http://svn.apache.org/repos/asf/commons/proper/commons-release-plugin/trunk/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/proper/commons-release-plugin/trunk/src/main/resources/commons-xdoc-templates/vote-txt-template.md";>vote-txt-template.md</a> + template</li> + <li>Uses the <a href="vote-txt-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 VOTE.txt, the following <a href="vote-txt-mojo.html">properties</a> are configured in the component's <code>pom.xml</code> + <ul> + <li><b>commons.componentid</b> - Commons component ID</li> + <li><b>commons.release.version</b> - The version number of the latest release of the component</li> + </ul> + </p> + <p> + Example configuration for Commons Chain: +<source><![CDATA[ + <properties> + <commons.componentid>chain</commons.componentid> + <commons.release.version>1.4</commons.release.version> + </properties> +]]></source> + </p> + </subsection> + + </section> + + </body> +</document>
