scm:update

Update the local working copy with the latest source from the configured scm url.

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}.
developerConnectionUrl String The SCM connection URL for developers. Default value is ${project.scm.developerConnection}.
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.
revisionKey String The project property where to store the revision name. Default value is scm.revision.
runChangelog boolean Run Changelog after update. Default value is false.
scmVersion String The version (revision number/branch name/tag name).
scmVersionType String The version type (branch/tag/revision) of scmVersion.
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).
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}

developerConnectionUrl

The SCM connection URL for developers.

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

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

revisionKey

The project property where to store the revision name.

  • Type: java.lang.String
  • Required: No
  • Expression: ${revisionKey}
  • Default: scm.revision

runChangelog

Run Changelog after update.

  • Type: boolean
  • Required: No
  • Expression: ${runChangelog}
  • Default: false

scmVersion

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

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

scmVersionType

The version type (branch/tag/revision) of scmVersion.

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

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}

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}