Maven Changes plugin - changes:changes-report

changes:changes-report

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

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.3: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.

Optional Parameters

Name	Type	Since	Description
addActionDate	`boolean`	`2.1`	A flag whether the report should also include the dates of individual actions. If set to `false`, only the dates of releases will be written to the report. Default value is: `false`.
filteringChanges	`boolean`	`2.2`	applying filtering filtering "a la" resources plugin Default value is: `false`.
issueLinkTemplate	`String`	`2.0-beta-2`	Deprecated. As of 2.1 use issueLinkTemplatePerSystem : this one will be with system default Default value is: `%URL%/ViewIssue.jspa?key=%ISSUE%`.
issueLinkTemplatePerSystem	`Map`	`2.1`	Template strings per system that is used to discover the URL to use to display an issue report. Each key in this map denotes the (case-sensitive) identifier of the issue tracking system and its value gives the URL template. 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: The deprecated issueLinkTemplate will be used for a system called "default".
outputDirectory	`File`	`-`	Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead. Default value is: `${project.reporting.outputDirectory}`.
publishDateFormat	`String`	`2.2`	Format to use for publishDate. The value will be available with the following expression ${publishDate} Default value is: `yyyy-MM-dd`.
publishDateLocale	`String`	`2.2`	Locale to use for publishDate when formatting Default value is: `en`.
xmlPath	`File`	`-`	The path of the `changes.xml` file that will be converted into an HTML report. Default value is: `src/changes/changes.xml`.

Parameter Details

addActionDate:

A flag whether the report should also include the dates of individual actions. If set to false, only the dates of releases will be written to the report.

Type: boolean
Since: 2.1
Required: No
Expression: ${changes.addActionDate}
Default: false

filteringChanges:

applying filtering filtering "a la" resources plugin

Type: boolean
Since: 2.2
Required: No
Default: false

issueLinkTemplate:

Deprecated. As of 2.1 use issueLinkTemplatePerSystem : this one will be with system default

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: ${changes.issueLinkTemplate}
Default: %URL%/ViewIssue.jspa?key=%ISSUE%

issueLinkTemplatePerSystem:

Template strings per system that is used to discover the URL to use to display an issue report. Each key in this map denotes the (case-sensitive) identifier of the issue tracking system and its value gives the URL template.

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: The deprecated issueLinkTemplate will be used for a system called "default".

Type: java.util.Map
Since: 2.1
Required: No

outputDirectory:

Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

Type: java.io.File
Required: No
Default: ${project.reporting.outputDirectory}

publishDateFormat:

Format to use for publishDate. The value will be available with the following expression ${publishDate}