changes:changes-report

Note: This Mojo should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.0:changes-report

Description:

Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
outputDirectory File - Report output directory.
xmlPath File - The path of the changes.xml file that will be converted into an html report.

Optional Parameters

Name Type Since Description
issueLinkTemplate String 2.0-beta-2 Template string that is used to discover the URL to use to display an issue report. There are 2 template tokens you can use. %URL%: this is computed by getting the <issueManagement>/<url> value from the POM, and removing the last '/' and everything that comes after it. %ISSUE% : this is the issue number.

Note: In versions of this plugin prior to 2.0-beta-2 this parameter was called link_template.

Parameter Details

issueLinkTemplate :

Template string that is used to discover the URL to use to display an issue report. There are 2 template tokens you can use. %URL%: this is computed by getting the <issueManagement>/<url> value from the POM, and removing the last '/' and everything that comes after it. %ISSUE% : this is the issue number.

Note: In versions of this plugin prior to 2.0-beta-2 this parameter was called link_template.

  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • Expression: %URL%/ViewIssue.jspa?key=%ISSUE%

outputDirectory :

Report output directory.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}

xmlPath :

The path of the changes.xml file that will be converted into an html report.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/changes/changes.xml