Author: britter
Date: Wed Aug 20 09:54:38 2014
New Revision: 1619060
URL: http://svn.apache.org/r1619060
Log:
Add a mojo for generating README.md files based on project meta data
Added:
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/readme-md-template.md
- copied, changed from r1612476,
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md-mojo.xml
- copied, changed from r1612476,
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md.xml
- copied, changed from r1612476,
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml
Modified:
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
commons/proper/commons-build-plugin/trunk/src/site/site.xml
Copied:
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/readme-md-template.md
(from r1612476,
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml)
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/readme-md-template.md?p2=commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/readme-md-template.md&p1=commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml&r1=1612476&r2=1619060&rev=1619060&view=diff
==============================================================================
---
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml
(original)
+++
commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/readme-md-template.md
Wed Aug 20 09:54:38 2014
@@ -1,21 +1,20 @@
-<?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.
+<!---
+ 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 ****|
@@ -26,180 +25,71 @@ limitations under the License.
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:mail-page |
+ | 1) Re-generate using: mvn commons:readme-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
| |
| 3) Example Properties |
| |
| <properties> |
| <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
| </properties> |
| |
+======================================================================+
--->
-<document>
- <properties>
- <title>@NAME@ Mailing Lists</title>
- <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
- </properties>
- <body>
-
- <section name="Overview">
- <p>
- <a href="index.html">@NAME@</a> shares mailing lists with all the other
- <a href="http://commons.apache.org/components.html";>Commons
Components</a>.
- To make it easier for people to only read messages related to
components they are interested in,
- the convention in Commons is to prefix the subject line of messages
with the component's name,
- for example:
- <ul>
- <li>[@ID@] Problem with the ...</li>
- </ul>
- </p>
- <p>
- Questions related to the usage of @NAME@ should be posted to the
- <a href="http://mail-archives.apache.org/mod_mbox/commons-user/";>User
List</a>.
- <br />
- The <a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/";>Developer List</a>
- is for questions and discussion related to the development of @NAME@.
- <br />
- Please do not cross-post; developers are also subscribed to the user
list.
- <br />
- You must be subscribed to post to the mailing lists. Follow the
Subscribe links below
- to subscribe.
- </p>
- <p>
- <strong>Note:</strong> please don't send patches or attachments to any
of the mailing lists.
- Patches are best handled via the <a href="issue-tracking.html">Issue
Tracking</a> system.
- Otherwise, please upload the file to a public server and include the
URL in the mail.
- </p>
- </section>
-
- <section name="@NAME@ Mailing Lists">
- <p>
- <strong>Please prefix the subject line of any messages for <a
href="index.html">@NAME@</a>
- with <i>[@ID@]</i></strong> - <i>thanks!</i>
- <br />
- <br />
- </p>
-
- <table>
- <tr>
- <th>Name</th>
- <th>Subscribe</th>
- <th>Unsubscribe</th>
- <th>Post</th>
- <th>Archive</th>
- <th>Other Archives</th>
- </tr>
-
-
- <tr>
- <td>
- <strong>Commons User List</strong>
- <br /><br />
- Questions on using @NAME@.
- <br /><br />
- </td>
- <td><a
href="mailto:user-subscr...@commons.apache.org";>Subscribe</a></td>
- <td><a
href="mailto:user-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
- <td><a
href="mailto:u...@commons.apache.org?subject=[@ID@]";>Post</a></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-user/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.users/";>markmail.org</a><br />
- <a
href="http://www.mail-archive.com/user@commons.apache.org/";>www.mail-archive.com</a><br
/>
- <a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a>
- </td>
- </tr>
-
-
- <tr>
- <td>
- <strong>Commons Developer List</strong>
- <br /><br />
- Discussion of development of @NAME@.
- <br /><br />
- </td>
- <td><a
href="mailto:dev-subscr...@commons.apache.org";>Subscribe</a></td>
- <td><a
href="mailto:dev-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
- <td><a
href="mailto:d...@commons.apache.org?subject=[@ID@]";>Post</a></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.dev/";>markmail.org</a><br />
- <a
href="http://www.mail-archive.com/dev@commons.apache.org/";>www.mail-archive.com</a><br
/>
- <a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a>
- </td>
- </tr>
-
-
- <tr>
- <td>
- <strong>Commons Issues List</strong>
- <br /><br />
- Only for e-mails automatically generated by the <a
href="issue-tracking.html">issue tracking</a> system.
- <br /><br />
- </td>
- <td><a
href="mailto:issues-subscr...@commons.apache.org";>Subscribe</a></td>
- <td><a
href="mailto:issues-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
- <td><i>read only</i></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-issues/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.issues/";>markmail.org</a><br
/>
- <a
href="http://www.mail-archive.com/issues@commons.apache.org/";>www.mail-archive.com</a>
- </td>
- </tr>
-
-
- <tr>
- <td>
- <strong>Commons Commits List</strong>
- <br /><br />
- Only for e-mails automatically generated by the <a
href="source-repository.html">source control</a> sytem.
- <br /><br />
- </td>
- <td><a
href="mailto:commits-subscr...@commons.apache.org";>Subscribe</a></td>
- <td><a
href="mailto:commits-unsubscr...@commons.apache.org";>Unsubscribe</a></td>
- <td><i>read only</i></td>
- <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-commits/";>mail-archives.apache.org</a></td>
- <td><a
href="http://markmail.org/list/org.apache.commons.commits/";>markmail.org</a><br
/>
- <a
href="http://www.mail-archive.com/commits@commons.apache.org/";>www.mail-archive.com</a>
- </td>
- </tr>
-
- </table>
-
- </section>
- <section name="Apache Mailing Lists">
- <p>
- Other mailing lists which you may find useful include:
- </p>
-
- <table>
- <tr>
- <th>Name</th>
- <th>Subscribe</th>
- <th>Unsubscribe</th>
- <th>Post</th>
- <th>Archive</th>
- <th>Other Archives</th>
- </tr>
- <tr>
- <td>
- <strong>Apache Announce List</strong>
- <br /><br />
- General announcements of Apache project releases.
- <br /><br />
- </td>
- <td><a class="externalLink"
href="mailto:announce-subscr...@apache.org";>Subscribe</a></td>
- <td><a class="externalLink"
href="mailto:announce-unsubscr...@apache.org";>Unsubscribe</a></td>
- <td><i>read only</i></td>
- <td><a class="externalLink"
href="http://mail-archives.apache.org/mod_mbox/www-announce/";>mail-archives.apache.org</a></td>
- <td><a class="externalLink"
href="http://markmail.org/list/org.apache.announce/";>markmail.org</a><br />
- <a class="externalLink"
href="http://old.nabble.com/Apache-News-and-Announce-f109.html";>old.nabble.com</a><br
/>
- <a class="externalLink"
href="http://www.mail-archive.com/announce@apache.org/";>www.mail-archive.com</a><br
/>
- <a class="externalLink"
href="http://news.gmane.org/gmane.comp.apache.announce";>news.gmane.org</a>
- </td>
- </tr>
- </table>
-
- </section>
- </body>
-</document>
+--->
+@NAME@
+===================
+
+@DESCRIPTION@
+
+Documentation
+-------------
+
+More information can be found on the [homepage][home].
+The [JavaDoc][javadoc] can be browsed.
+Questions related to the usage of @NAME@ should be posted to the [user mailing
list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download page][download].
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>@GROUPID@</groupId>
+ <artifactId>@ARTIFACTID@</artifactId>
+ <version>@VERSION@</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept PRs via github. The [developer mailing list][ml] is the main channel
of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement][cla].
+
+License
+-------
+Code is under the [Apache Licence v2][license].
+
+Donations
+---------
+You like @NAME@? Then [donate back to the ASF][donate] to support the
development.
+
+[home]:http://commons.apache.org/proper/@ARTIFACTID@
+[javadoc]:http://commons.apache.org/proper/@ARTIFACTID@/javadocs/api-release
+[ml]:http://commons.apache.org/proper/@ARTIFACTID@/mail-lists.html
+[download]:http://commons.apache.org/proper/@ARTIFACTID@/download_@ID@.cgi
+[cla]:http://www.apache.org/licenses/#clas
+[license]:http://www.apache.org/licenses/LICENSE-2.0.txt
+[donate]:http://www.apache.org/foundation/contributing.html
Modified:
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml?rev=1619060&r1=1619059&r2=1619060&view=diff
==============================================================================
---
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
(original)
+++
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml
Wed Aug 20 09:54:38 2014
@@ -298,4 +298,40 @@
<copy file="${commonsMojoTempDir}/${file.name}"
tofile="src/site/xdoc/${file.name}" overwrite="true" filtering="true"/>
</target>
+ <!-- ========== Generate Mailing List Page
================================ -->
+
+ <target name="readme-md" description="Generate README.md">
+
+ <echo level="${level}" message="----- commons:readme-md - 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.release.version :
${commons.release.version}" />
+ <echo level="${level}" message="commons.componentid :
${commons.componentid}" />
+ <echo level="${level}" message="----- commons:readme-md - Parameters -
END -----" />
+
+ <echo level="info" message="*** Generating ${project.name} README.md
***" />
+
+ <!-- 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="readme-md">
+ <javaresource name="${commonsMojoXdocDir}/readme-md-template.md"/>
+ </loadresource>
+ <echo message="${readme-md}"
file="${commonsMojoTempDir}/readme-md-template.md" append="false" />
+
+ <!-- Copy the mail-lists template filtering to replace properties -->
+ <copy file="${commonsMojoTempDir}/readme-md-template.md"
tofile="README.md" overwrite="true">
+ <filterset>
+ <filter token="NAME" value="${project.name}"/>
+ <filter token="ARTIFACTID" value="${project.artifactId}"/>
+ <filter token="GROUPID" value="${project.groupId}"/>
+ <filter token="VERSION" value="${commons.release.version}"/>
+ <filter token="DESCRIPTION" value="${project.description}"/>
+ <filter token="ID" value="${commons.componentid}"/>
+ </filterset>
+ </copy>
+
+ </target>
</project>
Modified:
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml?rev=1619060&r1=1619059&r2=1619060&view=diff
==============================================================================
---
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
(original)
+++
commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml
Wed Aug 20 09:54:38 2014
@@ -256,5 +256,67 @@
</parameter>
</parameters>
</mojo>
+ <mojo>
+ <goal>readme-md</goal>
+ <call>readme-md</call>
+ <description>Commons Build Ant Mojo: Generate
README.md</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.description</name>
+ <property>project.description</property>
+ <required>true</required>
+ <readonly>true</readonly>
+ <defaultValue>${project.description}</defaultValue>
+ <type>java.lang.String</type>
+ <description>A description 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>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>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.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>
+ </parameters>
+ </mojo>
</mojos>
</pluginMetadata>
Modified: commons/proper/commons-build-plugin/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/site.xml?rev=1619060&r1=1619059&r2=1619060&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/site.xml (original)
+++ commons/proper/commons-build-plugin/trunk/src/site/site.xml Wed Aug 20
09:54:38 2014
@@ -42,6 +42,10 @@
<item name="mail-page" href="/mail-page.html"/>
<item name="properties" href="/mail-page-mojo.html"/>
</item>
+ <item name="README.md" href="/readme-md.html">
+ <item name="readme-md" href="/readme-md.html"/>
+ <item name="properties" href="/readme-md-mojo.html"/>
+ </item>
<item name="Help" href="/development.html">
<item name="Issue Tracking" href="/issue-tracking.html"/>
<item name="Development" href="/development.html"/>
Copied:
commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md-mojo.xml
(from r1612476,
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml)
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md-mojo.xml?p2=commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md-mojo.xml&p1=commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml&r1=1612476&r2=1619060&rev=1619060&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page-mojo.xml
(original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md-mojo.xml
Wed Aug 20 09:54:38 2014
@@ -21,14 +21,14 @@
-->
<document>
<properties>
- <title>commons:mail-page</title>
+ <title>commons:readme-md</title>
</properties>
<body>
- <section name="commons:mail-page">
+ <section name="commons:readme-md">
<p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.3:mail-page</p>
+ <p>org.apache.commons:commons-build-plugin:1.5:readme-md</p>
<p><strong>Description</strong>:</p>
- <div>Commons Build Ant Mojo: Generate Mailing List page</div>
+ <div>Commons Build Ant Mojo: Generate README.md</div>
<p><strong>Attributes</strong>:</p>
<ul>
<li>Requires a Maven 2.0 project to be executed.</li>
@@ -43,6 +43,18 @@
<th>Description</th>
</tr>
<tr>
+ <td><strong><a
href="#commons.release.version">commons.release.version</a></strong></td>
+ <td><code>String</code></td>
+ <td><code>-</code></td>
+ <td>The version of the latest release of the
project.<br/><strong>Default value is</strong>:
<code>${commons.release.version}</code>.</td>
+ </tr>
+ <tr>
+ <td><strong><a
href="#commons.componentid">commons.componentid</a></strong></td>
+ <td><code>String</code></td>
+ <td><code>-</code></td>
+ <td>Commons component id.<br/><strong>Default value is</strong>:
<code>${commons.componentid}</code>.</td>
+ </tr>
+ <tr>
<td><strong><a href="#basedir">basedir</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
@@ -67,7 +79,19 @@
</table>
</subsection>
<subsection name="Parameter Details">
- <p><strong><a name="basedir">basedir</a>:</strong></p>
+ <p><strong><a
name="commons.release.version">commons.release.version</a>:</strong></p>
+ <div>The version of the latest release of the project.</div>
+ <ul>
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>Yes</code></li>
+ <li><strong>Default</strong>:
<code>${commons.release.version}</code></li>
+ </ul><hr/><p><strong><a
name="commons.componentid">commons.componentid</a>:</strong></p>
+ <div>The Commons componentid.</div>
+ <ul>
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>Yes</code></li>
+ <li><strong>Default</strong>:
<code>${commons.componentid}</code></li>
+ </ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
<li><strong>Type</strong>: <code>java.io.File</code></li>
Copied: commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md.xml
(from r1612476,
commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml)
URL:
http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md.xml?p2=commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md.xml&p1=commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml&r1=1612476&r2=1619060&rev=1619060&view=diff
==============================================================================
--- commons/proper/commons-build-plugin/trunk/src/site/xdoc/mail-page.xml
(original)
+++ commons/proper/commons-build-plugin/trunk/src/site/xdoc/readme-md.xml Wed
Aug 20 09:54:38 2014
@@ -29,39 +29,40 @@
<body>
- <section name="commons:mail-page" href="mail-page">
+ <section name="commons:readme-md" href="readme-md">
<subsection name="Overview">
<p>
- The <code>commons:mail-page</code> goal generates a custom
Mailing List page for a component
- Execute the goal using the following command: <source>mvn
commons:mail-page</source>
+ The <code>commons:readme-md</code> goal generates a README.md
file for a component.
+ Execute the goal using the following command: <source>mvn
commons:readme-md</source>
</p>
<p>
- <strong>Note:</strong> The Mailing List page should only need
to be generated initially
- for a component or if the Mailing List template changes.
+ <strong>Note:</strong> The README.md should be regenerated
after every release of the
+ component since it contains the maven coordinates of the
latest release.
</p>
<p>
This goal uses the following:
<ul>
- <li>The goal is mapped to the ant script/target using the
<code>mail-page</code> mojo defintion in the
+ <li>The goal is mapped to the ant script/target using the
<code>readme-md</code> mojo defintion in the
<a
href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a>
mapping document</li>
- <li>Executes the <code>mail-page</code> target in
+ <li>Executes the <code>readme-md</code> target in
<a
href="http://svn.apache.org/repos/asf/commons/proper/commons-build-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-build-plugin/trunk/src/main/resources/commons-xdoc-templates/mail-lists-template.xml";>mail-lists-template.xml</a>
+ <li>Uses the <a
href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/readme-md-template.md";>readme-md-template.md</a>
template</li>
- <li>Uses the <a href="mail-page-mojo.html">goal's (i.e.
mojo's) parameters</a> to filter values in the template</li>
+ <li>Uses the <a href="readme-md-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 Mailing List page, the following <a
href="mail-page-mojo.html">properties</a> are configured in the component's
<code>pom.xml</code>
+ To generate a README.md, the following <a
href="readme-md-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>
@@ -69,6 +70,7 @@
<source><![CDATA[
<properties>
<commons.componentid>chain</commons.componentid>
+ <commons.release.version>1.4</commons.release.version>
</properties>
]]></source>
</p>
