scm:changelog

Dump changelog contents to console. It is mainly used to test maven-scm-api's changelog command.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Executes as an aggregator plugin.

Required Parameters

Name Type Description
basedir File The base directory.

Optional Parameters

Name Type 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}.
dateFormat String Date Format in changelog output of scm tool.
developerConnectionUrl String The SCM connection URL for developers. Default value is ${project.scm.developerConnection}.
endDate String End Date.
excludes String Comma separated list of excludes file pattern.
includes String Comma separated list of includes file pattern.
passphrase String The passphrase (used by java svn).
password String The user password (used by svn, starteam and perforce protocol).
privateKey String The private key (used by java svn).
providerImplementations Map List of provider implementations.
scmVersion String The version (revision number/branch name/tag name).
scmVersionType String The version type (branch/tag) of scmVersion.
startDate String Start Date.
systemProperties Properties List of System properties to pass to the JUnit tests.
tagBase String The url of tags base directory (used by svn protocol). It is not necessary to set it if you use the standard svn layout (branches/tags/trunk).
userDateFormat String Date format to use for the specified startDate and/or endDate. Default value is yyyy-MM-dd.
username String The user name (used by svn, starteam and perforce protocol).
workingDirectory File The working directory.

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

Date Format in changelog output of scm tool.

  • Type: java.lang.String
  • Required: No
  • Expression: ${dateFormat}

developerConnectionUrl

The SCM connection URL for developers.

  • Type: java.lang.String
  • Required: No
  • Expression: ${connectionUrl}
  • Default: ${project.scm.developerConnection}

endDate

End Date.

  • Type: java.lang.String
  • Required: No
  • Expression: ${endDate}

excludes

Comma separated list of excludes file pattern.

  • Type: java.lang.String
  • Required: No
  • Expression: ${excludes}

includes

Comma separated list of includes file pattern.

  • Type: java.lang.String
  • Required: No
  • Expression: ${includes}

passphrase

The passphrase (used by java svn).

  • Type: java.lang.String
  • Required: No
  • Expression: ${passphrase}

password

The user password (used by svn, starteam and perforce 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}

providerImplementations

List of provider implementations.

  • Type: java.util.Map
  • Required: No

scmVersion

The version (revision number/branch name/tag name).

  • Type: java.lang.String
  • Required: No
  • Expression: ${scmVersion}

scmVersionType

The version type (branch/tag) of scmVersion.

  • Type: java.lang.String
  • Required: No
  • Expression: ${scmVersionType}

startDate

Start Date.

  • Type: java.lang.String
  • Required: No
  • Expression: ${startDate}

systemProperties

List of System properties to pass to the JUnit tests.

  • Type: java.util.Properties
  • Required: No

tagBase

The url of tags base directory (used by svn protocol). It is not necessary to set it if you use the standard svn layout (branches/tags/trunk).

  • Type: java.lang.String
  • Required: No
  • Expression: ${tagBase}

userDateFormat

Date format to use for the specified startDate and/or endDate.

  • Type: java.lang.String
  • Required: No
  • Expression: ${userDateFormat}
  • Default: yyyy-MM-dd

username

The user name (used by svn, starteam and perforce protocol).

  • Type: java.lang.String
  • Required: No
  • Expression: ${username}

workingDirectory

The working directory.

  • Type: java.io.File
  • Required: No
  • Expression: ${workingDirectory}