vmassol 2004/04/20 12:39:53
Modified: changes/xdocs index.xml changes.xml
Log:
Added documentation for the format of <code>changes.xml</code> file.
Revision Changes Path
1.4 +96 -5 maven-plugins/changes/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/changes/xdocs/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 4 Mar 2004 18:40:25 -0000 1.3
+++ index.xml 20 Apr 2004 19:39:52 -0000 1.4
@@ -20,16 +20,18 @@
<document>
<properties>
- <title>Maven Changes Plug-in</title>
+ <title>Maven Changes plugin</title>
<author email="[EMAIL PROTECTED]">Vincent Massol</author>
</properties>
<body>
- <section name="Maven Changes Plug-in">
+ <section name="Maven Changes plugin">
<p>
This plugin produces a changes report showing the differences
between different releases of the project using it.
</p>
+ </section>
+ <section name="Using the plugin">
<p>
In order to use this plugin, simply create a <code>changes.xml</code>
file in your <code>xdocs</code> directory. Here's an example of a
@@ -53,20 +55,109 @@
<action dev="vmassol" type="add">
Added blah blah.
</action>
- <action dev="vmassol" type="fix">
+ <action dev="vmassol" type="fix" issues="JIRA-XXX">
Corrected bug blah blah.
</action>
- <action dev="vmassol" type="remove">
+ <action dev="vmassol" type="remove" due-to="John Doe" due-to-email="[EMAIL
PROTECTED]">
Removed blah blah.
</action>
</release>
</body>
</document>
]]></source>
+
<p>
A live Changes example report can be found
- <a
href="http://maven.apache.org/reference/plugins/cactus/changes-report.html";>here</a>.
+ <a
href="http://maven.apache.org/reference/plugins/changes/changes-report.html";>here</a>.
</p>
+
+ <p>
+ The following attributes are supported for the <code><release></code>
+ element:
+ </p>
+
+ <table>
+ <tr>
+ <th>Attribute name</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>version</td>
+ <td>
+ Name of the version for which to describe the changes. For each
+ change, add a nested <code><action></code> element as
+ described below.
+ </td>
+ <td>yes</td>
+ </tr>
+ <tr>
+ <td>date</td>
+ <td>
+ Date at which the version was released. You can use a free form
+ comment such as "in CVS" for unreleased versions.
+ </td>
+ <td>yes</td>
+ </tr>
+ </table>
+
+ <p>
+ The following attributes are supported for the <code><action></code>
+ element:
+ </p>
+
+ <table>
+ <tr>
+ <th>Attribute name</th>
+ <th>Description</th>
+ <th>Required?</th>
+ </tr>
+ <tr>
+ <td>dev</td>
+ <td>
+ Name of developer who committed the change. This must be the name
+ of the developer as described in the <code>developers</code>
+ section of the POM (<code>project.xml</code> file).
+ </td>
+ <td>yes</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>
+ Type of change. There are four valid values:
+ <code>add</code>, <code>fix</code>, <code>remove</code>,
+ <code>update</code>.
+ </td>
+ <td>yes</td>
+ </tr>
+ <tr>
+ <td>issue</td>
+ <td>
+ Id of the issue related to this change. This is the id in your
+ bug tracking system. The Changes plugin will generate a URL out
+ of this id. The URL is constructed by using the
+ <code>maven.changes.issue.template</code> property. See the
+ <a href="properties.html">page</a> for more details.
+ </td>
+ <td>no</td>
+ </tr>
+ <tr>
+ <td>due-to</td>
+ <td>
+ Name of the person to be credited for this change. To be used
+ when a patch is submitted by a non-committer.
+ </td>
+ <td>no</td>
+ </tr>
+ <tr>
+ <td>due-to-email</td>
+ <td>
+ Email of the person to be credited for this change.
+ </td>
+ <td>no</td>
+ </tr>
+ </table>
+
</section>
</body>
</document>
1.16 +4 -1 maven-plugins/changes/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/maven-plugins/changes/xdocs/changes.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- changes.xml 10 Apr 2004 03:02:40 -0000 1.15
+++ changes.xml 20 Apr 2004 19:39:52 -0000 1.16
@@ -24,7 +24,10 @@
<author email="[EMAIL PROTECTED]">Vincent Massol</author>
</properties>
<body>
- <release version="1.4-SNAPSHOT" date="in CVS">
+ <release version="1.4" date="in CVS">
+ <action dev="vmassol" type="add" due-to="Trygve Laugst?l" issue="MPCHANGES-5">
+ Added documentation for the format of <code>changes.xml</code> file.
+ </action>
<action dev="brett" type="fix" due-to="Tim Shadel" issue="MPCHANGES-6">Fix
anchor links in report</action>
</release>
<release version="1.3" date="2004-03-07">
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
