scm:branch

Full name:

org.apache.maven.plugins:maven-scm-plugin:1.11.1:branch

Description:

Branch the project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.

Required Parameters

Name Type Since Description
basedir File - The base directory.
User property is: basedir.
branch String - The branch name.
User property is: branch.

Optional Parameters

Name Type Since Description
connectionType String - The type of connection to use (connection or developerConnection).
Default value is: connection.
User property is: connectionType.
connectionUrl String - The SCM connection URL.
Default value is: ${project.scm.connection}.
User property is: connectionUrl.
developerConnectionUrl String - The SCM connection URL for developers.
Default value is: ${project.scm.developerConnection}.
User property is: developerConnectionUrl.
excludes String - Comma separated list of excludes file pattern.
User property is: excludes.
includes String - Comma separated list of includes file pattern.
User property is: includes.
message String - The message applied to the tag creation.
User property is: message.
passphrase String - The passphrase (used by java svn).
User property is: passphrase.
password String - The user password (used by svn, starteam and perforce protocol).
User property is: password.
pinExternals boolean 1.11.0 Currently only implemented with Subversion. Enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9.
Default value is: false.
User property is: pinExternals.
privateKey String - The private key (used by java svn).
User property is: privateKey.
providerImplementations Map - List of provider implementations.
pushChanges boolean 1.4 Should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.
Default value is: true.
User property is: pushChanges.
remoteBranching boolean 1.3 currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)
Default value is: true.
User property is: remoteBranching.
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).
User property is: tagBase.
username String - The user name (used by svn, starteam and perforce protocol).
User property is: username.
workItem String 1.9.5 A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.
User property is: workItem.
workingDirectory File - The working directory.
User property is: workingDirectory.

Parameter Details

basedir:

The base directory.
  • Type: java.io.File
  • Required: Yes
  • User Property: basedir

branch:

The branch name.
  • Type: java.lang.String
  • Required: Yes
  • User Property: branch

connectionType:

The type of connection to use (connection or developerConnection).
  • Type: java.lang.String
  • Required: No
  • User Property: connectionType
  • Default: connection

connectionUrl:

The SCM connection URL.
  • Type: java.lang.String
  • Required: No
  • User Property: connectionUrl
  • Default: ${project.scm.connection}

developerConnectionUrl:

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

excludes:

Comma separated list of excludes file pattern.
  • Type: java.lang.String
  • Required: No
  • User Property: excludes

includes:

Comma separated list of includes file pattern.
  • Type: java.lang.String
  • Required: No
  • User Property: includes

message:

The message applied to the tag creation.
  • Type: java.lang.String
  • Required: No
  • User Property: message

passphrase:

The passphrase (used by java svn).
  • Type: java.lang.String
  • Required: No
  • User Property: passphrase

password:

The user password (used by svn, starteam and perforce protocol).
  • Type: java.lang.String
  • Required: No
  • User Property: password

pinExternals:

Currently only implemented with Subversion. Enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9.
  • Type: boolean
  • Since: 1.11.0
  • Required: No
  • User Property: pinExternals
  • Default: false

privateKey:

The private key (used by java svn).
  • Type: java.lang.String
  • Required: No
  • User Property: privateKey

providerImplementations:

List of provider implementations.
  • Type: java.util.Map
  • Required: No

pushChanges:

Should distributed changes be pushed to the central repository? For many distributed SCMs like Git, a change like a commit is only stored in your local copy of the repository. Pushing the change allows your to more easily share it with other users.
  • Type: boolean
  • Since: 1.4
  • Required: No
  • User Property: pushChanges
  • Default: true

remoteBranching:

currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)
  • Type: boolean
  • Since: 1.3
  • Required: No
  • User Property: remoteBranching
  • Default: true

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
  • User Property: tagBase

username:

The user name (used by svn, starteam and perforce protocol).
  • Type: java.lang.String
  • Required: No
  • User Property: username

workItem:

A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.
  • Type: java.lang.String
  • Since: 1.9.5
  • Required: No
  • User Property: workItem

workingDirectory:

The working directory.
  • Type: java.io.File
  • Required: No
  • User Property: workingDirectory