changelog:file-activity

Generate a file activity report.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.

Required Parameters

Name Type Description
basedir File Input dir. Directory where the files under SCM control are located.
connectionType String Allows the user to choose which scm connection to use when connecting to the scm. Can either be "connection" or "developerConnection". Default value is connection.
dateFormat String Used to specify the date format of the log entries that are retrieved from your SCM system. Default value is yyyy-MM-dd HH:mm:ss.
outputEncoding String Output encoding for the xml document Default value is ISO-8859-1.
outputXML File Output file for xml document
outputXMLExpiration int Allows the user to make changelog regenerate the changelog.xml file for the specified time in minutes. Default value is 60.
type String Used to specify whether to build the log using range, tag or date. Default value is range.

Optional Parameters

Name Type Description
commentFormat String Comment format string used for interrogating the revision control system. Currently only used by the ClearcaseChangeLogGenerator.
dates List Used to specify the absolute date (or list of dates) to start log entries from.
displayFileDetailUrl String A template string that is used to create the URL to the file details. There is a special token that you can use in your template:
  • %FILE% - this is the path to a file
Example: http://checkstyle.cvs.sourceforge.net/checkstyle%FILE%?view=markup

Note: If you don't supply the token in your template, the path of the file will simply be appended to your template URL.

headingDateFormat String Used to specify the format to use for the dates in the headings of the report. Default value is yyyy-MM-dd.
passphrase String The passphrase (used by java svn).
password String The user password (used by svn and starteam protocol).
privateKey String The private key (used by java svn).
range int Used to specify the number of days of log entries to retrieve. Default value is -1.
scmUrl String The URL to view the scm. Basis for external links from the generated report.
systemProperties Properties The system properties to use (needed by the perforce scm provider).
tagBase String The url of tags base directory (used by svn protocol).
tags List Used to specify the tag (or list of tags) to start log entries from.
username String The user name (used by svn and starteam protocol).

Parameter Details

basedir

Input dir. Directory where the files under SCM control are located.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}
commentFormat Comment format string used for interrogating the revision control system. Currently only used by the ClearcaseChangeLogGenerator.
  • Type: java.lang.String
  • Required: No
  • Expression: ${changelog.commentFormat}
connectionType Allows the user to choose which scm connection to use when connecting to the scm. Can either be "connection" or "developerConnection".
  • Type: java.lang.String
  • Required: Yes
  • Default: connection
dateFormat Used to specify the date format of the log entries that are retrieved from your SCM system.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${changelog.dateFormat}
  • Default: yyyy-MM-dd HH:mm:ss
dates Used to specify the absolute date (or list of dates) to start log entries from.
  • Type: java.util.List
  • Required: No
displayFileDetailUrl A template string that is used to create the URL to the file details. There is a special token that you can use in your template:
  • %FILE% - this is the path to a file
Example: http://checkstyle.cvs.sourceforge.net/checkstyle%FILE%?view=markup Note: If you don't supply the token in your template, the path of the file will simply be appended to your template URL.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.scm.url}
headingDateFormat Used to specify the format to use for the dates in the headings of the report.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${changelog.headingDateFormat}
  • Default: yyyy-MM-dd
outputEncoding Output encoding for the xml document
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${changelog.outputEncoding}
  • Default: ISO-8859-1
outputXML Output file for xml document
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/changelog.xml
outputXMLExpiration Allows the user to make changelog regenerate the changelog.xml file for the specified time in minutes.
  • Type: int
  • Required: Yes
  • Expression: ${outputXMLExpiration}
  • Default: 60
passphrase The passphrase (used by java svn).
  • Type: java.lang.String
  • Required: No
  • Expression: ${passphrase}
password The user password (used by svn and starteam protocol).
  • Type: java.lang.String
  • Required: No
  • Expression: ${password}
privateKey The private key (used by java svn).
  • Type: java.lang.String
  • Required: No
  • Expression: ${privateKey}
range Used to specify the number of days of log entries to retrieve.
  • Type: int
  • Required: No
  • Expression: ${changelog.range}
  • Default: -1
scmUrl The URL to view the scm. Basis for external links from the generated report.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.scm.url}
systemProperties The system properties to use (needed by the perforce scm provider).
  • Type: java.util.Properties
  • Required: No
tagBase The url of tags base directory (used by svn protocol).
  • Type: java.lang.String
  • Required: No
  • Expression: ${tagBase}
tags Used to specify the tag (or list of tags) to start log entries from.
  • Type: java.util.List
  • Required: No
type Used to specify whether to build the log using range, tag or date.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${changelog.type}
  • Default: range
username The user name (used by svn and starteam protocol).
  • Type: java.lang.String
  • Required: No
  • Expression: ${username}