scmchangelog:report

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

Full name:

org.codehaus.mojo:scmchangelog-maven-plugin:1.3:report

Description:

Goal which produces a changelog report based on the Subversion logs.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
basedir File - The base directory.
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.
grammar String - Grammar name for parsing svn logs
Default value is: MANU.
timestampFormat String - Used to specify the date format of the log entries that are retrieved from your SCM system.
Default value is: dd/MM/yyyy HH:mm.
trackerType String - Used to specify the tracker type.
Default value is: ${project.issueManagement.system}.
trackerUrlPattern String - Used to specify the tracker issue url pattern.
Default value is: ${project.issueManagement.url}.

Optional Parameters

Name Type Since Description
connectionType String - The type of connection to use (connection or developerConnection).
Default value is: connection.
connectionUrl String - The SCM connection URL.
Default value is: ${project.scm.connection}.
developerConnectionUrl String - The SCM connection URL for developers.
Default value is: ${project.scm.developerConnection}.
filter String - The regexp used to filter tags and branches names to produce the report.
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).
releasesOrder String - Used to specify if the releases should be ordered alphabetally or historically. Supported values are historic and alphabetic.
Default value is: historic.
tagBase String - The url of tags base directory (used by svn protocol).
username String - The user name (used by svn and starteam protocol).

Parameter Details

basedir:

The base directory.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}

connectionType:

The type of connection to use (connection or developerConnection).
  • Type: java.lang.String
  • Required: No
  • Expression: ${connectionType}
  • Default: connection

connectionUrl:

The SCM connection URL.
  • Type: java.lang.String
  • Required: No
  • Expression: ${connectionUrl}
  • Default: ${project.scm.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

developerConnectionUrl:

The SCM connection URL for developers.
  • Type: java.lang.String
  • Required: No
  • Expression: ${connectionUrl}
  • Default: ${project.scm.developerConnection}

filter:

The regexp used to filter tags and branches names to produce the report.
  • Type: java.lang.String
  • Required: No
  • Expression: ${filter}

grammar:

Grammar name for parsing svn logs
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${changelog.grammar}
  • Default: MANU

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}

releasesOrder:

Used to specify if the releases should be ordered alphabetally or historically. Supported values are historic and alphabetic.
  • Type: java.lang.String
  • Required: No
  • Expression: ${changelog.releasesOrder}
  • Default: historic

tagBase:

The url of tags base directory (used by svn protocol).
  • Type: java.lang.String
  • Required: No
  • Expression: ${tagBase}

timestampFormat:

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.timestampFormat}
  • Default: dd/MM/yyyy HH:mm

trackerType:

Used to specify the tracker type.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${changelog.trackerType}
  • Default: ${project.issueManagement.system}

trackerUrlPattern:

Used to specify the tracker issue url pattern.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${changelog.trackerUrlPattern}
  • Default: ${project.issueManagement.url}

username:

The user name (used by svn and starteam protocol).
  • Type: java.lang.String
  • Required: No
  • Expression: ${username}