Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added documentation for the format of <code>changes.xml</code> file.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115025 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol
2004-04-20 19:39:52 +00:00
parent e9227275a3
commit 7d89b44f6a
2 changed files with 100 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
changes/xdocs/index.xml
View File

@@ -20,16 +20,18 @@
<document>
<properties>
<title>Maven Changes Plug-in</title>
<title>Maven Changes plugin</title>
<author email="vmassol@apache.org">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="john@doe.com">
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>&lt;release&gt;</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>&lt;action&gt;</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>&lt;action&gt;</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>