Built by Maven

changes:trac-report

Note:

This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-changes-plugin:3.0.0-M1:trac-report

Deprecated:

use track-changes goal

Description:

Goal which downloads issues from the Issue Tracking System and generates a report.

Attributes:

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

Required Parameters

Name Type Since Description
<basedir> String 2.10 The current project base directory.
User Property: basedir
<outputDirectory> File - The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().


Default: ${project.build.directory}/reports

Optional Parameters

Name Type Since Description
<columnNames> String 2.2 Sets the column names that you want to show in the report. The columns will appear in the report in the same order as you specify them here. Multiple values can be separated by commas.

Valid columns are: Assignee, Component, Created, Fix Version, Id, Priority, Reporter, Resolution, Status, Summary, Type and Updated.


Default: Id,Type,Summary,Assignee,Reporter,Priority,Status,Resolution,Created,Updated
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
Default: default
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<query> String - Defines the Trac query for searching ticket.
Default: order=id
<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: false
User Property: changes.runOnlyAtExecutionRoot
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<tracPassword> String - Defines the Trac password for authentication into a private Trac installation.
<tracUser> String - Defines the Trac username for authentication into a private Trac installation.

Parameter Details

<basedir>

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

<columnNames>

Sets the column names that you want to show in the report. The columns will appear in the report in the same order as you specify them here. Multiple values can be separated by commas.

Valid columns are: Assignee, Component, Created, Fix Version, Id, Priority, Reporter, Resolution, Status, Summary, Type and Updated.

  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Default: Id,Type,Summary,Assignee,Reporter,Priority,Status,Resolution,Created,Updated

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<outputDirectory>

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<query>

Defines the Trac query for searching ticket.
  • Type: java.lang.String
  • Required: No
  • Default: order=id

<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

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<tracPassword>

Defines the Trac password for authentication into a private Trac installation.
  • Type: java.lang.String
  • Required: No

<tracUser>

Defines the Trac username for authentication into a private Trac installation.
  • Type: java.lang.String
  • Required: No