Changes

A recording of changes made during each release of a project. This file should record every changes made to the project. 

<document>
  <properties>
    <title/>
    <author email=.. />
  </properties>
  <body>
    <release version=.. date=.. description=.. >
      <action dev=.. due-to=.. due-to-email=.. issue=.. type=.. system=.. date=.. >
        <action/>
        <fixes issue=.. />
        <dueto name=.. email=.. />
      </action>
    </release>
  </body>
</document>

document

Record every release with their subsequent changes.

Element Type Description
properties Properties Contains the properties of this document.
body Body Contains the releases of this project with the actions taken for each of the releases.

properties

No description.

Element Type Description
title String Page Title.
author Author Page Author

author

A description of the author page.

Element Content: The page author name.

Attribute Type Description
email String The page author email.

body

No description.

Element Type Description
release* List<Release> (Many) The list of releases for this project.

release

A single release of this project.

Attribute Type Description
version String The version number associated with this release.
date String

The date of this release.

This field can be any String, such as "in SVN" when the version isn't yet released.

description String A short description of this release.
Element Type Description
action* List<Action> (Many) The list of actions taken for this release.

action

A single action done on the project, during this release.

Element Content: A short description of the action taken.

Attribute Type Description
dev String

Name of developer who committed the change.

This MUST be the name of the developer as described in the developers section of the pom.xml file.
due-to String Name of the person to be credited for this change. This can be used when a patch is submitted by a non-committer.
due-to-email String Email of the person to be credited for this change.
issue String

Id of the issue related to this change. This is the id in your issue tracking system.

The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the issueLinkTemplate parameter.

See the changes-report mojo for more details.
type String Supported action types are the following:
  • add : added functionnality to the project.
  • fix : bug fix for the project.
  • update : updated some part of the project.
  • remove : removed some functionnality from the project.
system String

Id of issue tracking system. If empty 'default' value will be use.

The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the issueLinkTemplatePerSystem parameter.

See the changes-report mojo for more details.
date String fix date
Element Type Description
fixes* List<FixedIssue> (Many) A list of fix issues.
dueto* List<DueTo> (Many) A list of contributors for this issue.

fixes

A fixed issue.

Attribute Type Description
issue String

Id of the issue related to this change. This is the id in your issue tracking system.

The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the issueLinkTemplate parameter.

See the changes-report mojo for more details.

dueto

Name and Email of the person to be credited for this change. This can be used when a patch is submitted by a non-committer.

Attribute Type Description
name String Name of the person to be credited for this change.
email String Email of the person to be credited for this change.