This plugin produces a changes report showing the differences between different releases of the project using it.
In order to use this plugin, you should add the following
to the reports section of your project.xml:
Then you have to create a changes.xml
file in your xdocs directory. Here's an example of a
typical changes.xml, showing the syntax:
An alternative form of the <action> element
allows you to specify several issues and/or several due-to
elements:
The <fixes> element takes one required issue
attribute, the <dueto> element requires only the name
attribute, the email is optional. Note that the <description>,
<fixes> and <dueto> elements take precedence over
any equivalent attributes defined in the <action> element.
A live Changes example report can be found here.
The following attributes are supported for the <release>
element:
| Attribute name | Description | Required? |
|---|---|---|
| version |
Name of the version for which to describe the changes. For each
change, add a nested <action> element as
described below.
|
yes |
| date | Date at which the version was released. You can use a free form comment such as "in CVS" for unreleased versions. | yes |
| description | An optional description of the release. This is used in the overview table of releases. | no |
The following attributes are supported for the <action>
element:
| Attribute name | Description | Required? |
|---|---|---|
| dev |
Name of developer who committed the change. This must be the name
of the developer as described in the developers
section of the POM (project.xml file).
|
yes |
| type |
Type of change. There are four valid values:
add, fix, remove,
update.
|
yes |
| issue |
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
maven.changes.issue.template property. See the
page for more details.
|
no |
| due-to | Name of the person to be credited for this change. To be used when a patch is submitted by a non-committer. | no |
| due-to-email | Email of the person to be credited for this change. | no |