changes:changes-report

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

Full name:

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

Description:

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

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
basedir String 2.10 The current project base directory.
User property is: basedir.

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.
User property is: changes.addActionDate.
aggregated boolean 2.5 A flag whether the report should also include changes from child modules. If set to false, only the changes from current project will be written to the report.
Default value is: false.
escapeHTML boolean 2.4 Deprecated. using markup inside CDATA sections does not work for all output formats!
Default value is: true.
feedType String 2.9 The type of the feed to generate.

Supported values are: "rss_0.9", "rss_0.91N" (RSS 0.91 Netscape), "rss_0.91U" (RSS 0.91 Userland), "rss_0.92", "rss_0.93", "rss_0.94", "rss_1.0", "rss_2.0", "atom_0.3", "atom_1.0".

If not specified, no feed is generated.
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%.
User property is: changes.issueLinkTemplate.
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-insensitive) 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".

Note: Starting with version 2.4 you usually don't need to specify this, unless you need to link to an issue management system in your Changes report that isn't supported out of the box. See the Usage page for more information.
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}.
outputEncoding String 2.4 Report output encoding. 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 encoding configured in the Maven Site Plugin is used instead.
Default value is: ${project.reporting.outputEncoding}.
User property is: outputEncoding.
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.
runOnlyAtExecutionRoot boolean 2.10 This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
Default value is: false.
User property is: changes.runOnlyAtExecutionRoot.
teamlist String 2.4 The URI of a file containing all the team members. If this is set to the special value "none", no links will be generated for the team members.
Default value is: team-list.html.
xmlPath File - The path of the changes.xml file that will be converted into an HTML report.
Default value is: src/changes/changes.xml.
User property is: changes.xmlPath.

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
  • User Property: changes.addActionDate
  • Default: false

aggregated:

A flag whether the report should also include changes from child modules. If set to false, only the changes from current project will be written to the report.
  • Type: boolean
  • Since: 2.5
  • Required: No
  • Default: false

basedir:

The current project base directory.
  • Type: java.lang.String
  • Since: 2.10
  • Required: Yes
  • User Property: basedir

escapeHTML:

Deprecated. using markup inside CDATA sections does not work for all output formats!
Whether HTML code within an action should be escaped. By changing this to false you can restore the behavior that was in version 2.2 of this plugin, allowing you to use HTML code to format the content of an action.

Note: If you use HTML code in an action you need to place it inside a CDATA section.

Note: Putting any kind of markup inside a CDATA section might mess up the Changes Report or other generated documents, such as PDFs, that are based on your changes.xml file if you are not careful.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: true

feedType:

The type of the feed to generate.

Supported values are: "rss_0.9", "rss_0.91N" (RSS 0.91 Netscape), "rss_0.91U" (RSS 0.91 Userland), "rss_0.92", "rss_0.93", "rss_0.94", "rss_1.0", "rss_2.0", "atom_0.3", "atom_1.0".

If not specified, no feed is generated.

  • Type: java.lang.String
  • Since: 2.9
  • Required: No

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
  • User Property: 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-insensitive) 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".

Note: Starting with version 2.4 you usually don't need to specify this, unless you need to link to an issue management system in your Changes report that isn't supported out of the box. See the Usage page for more information.

  • 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}

outputEncoding:

Report output encoding. 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 encoding configured in the Maven Site Plugin is used instead.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

publishDateFormat:

Format to use for publishDate. The value will be available with the following expression ${publishDate}
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Default: yyyy-MM-dd

publishDateLocale:

Locale to use for publishDate when formatting
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Default: en

runOnlyAtExecutionRoot:

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
  • Type: boolean
  • Since: 2.10
  • Required: No
  • User Property: changes.runOnlyAtExecutionRoot
  • Default: false

teamlist:

The URI of a file containing all the team members. If this is set to the special value "none", no links will be generated for the team members.
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Default: team-list.html

xmlPath:

The path of the changes.xml file that will be converted into an HTML report.
  • Type: java.io.File
  • Required: No
  • User Property: changes.xmlPath
  • Default: src/changes/changes.xml