Built by Maven

Apache Maven Changes Plugin

This plugin is used to inform your users of the changes that have occurred between different releases of your project. The plugin can extract these changes, either from a changes.xml file or from an issue management system (Jira, Trac and GitHub supported), and presents them as a report.

You also have the option of creating a release announcement and even sending it via email to your users.

Goals Overview

Usage

General instructions on how to use the Changes Plugin can be found on the usage page. Some more specific use cases are described in the examples given below.

In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

Migration to 3.x

changes.xml - schema changes

  • you should update schema in your changes.xml to 2.0.0 - Using the XML Schema.
  • tag action/dueto - was removed, you can put your data into existing due-to and dueToEmail attributes of action tag, which can be comma separated.
  • tag action/fixedIssues - was changed to an attribute of action tag, it also can be comma separated.

Report goals and output names

The reports output filename and goals name were changed for alignment with other reporting plugins from org.apache.maven.plugins.

See the following table for changes:

goal name output name
changes-report -> changes changes-report.html -> changes.html
github-report -> github-changes github-report.html -> github-changes.html
jira-report -> jira-changes jira-report.html -> jira-changes.html
trac-report -> trac-changes trac-report.html -> trac-changes.html

Deprecate Trac integration

Trac integration is prepared for removal in next major version due to lack of maintainers.

Examples

To provide you with better understanding of some usages of the Changes Plugin, you can take a look at the following examples: