scm:bootstrap

Full name:

org.apache.maven.plugins:maven-scm-plugin:1.9:bootstrap

Description:

Pull the project source from the configured scm and execute the configured goals.

Attributes:

Required Parameters

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

Optional Parameters

Name Type Since Description
checkoutDirectory File - The directory to checkout the sources to for the bootstrap and checkout goals.
Default value is: ${project.build.directory}/checkout.
User property is: checkoutDirectory.
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: connectionUrl.
excludes String - Comma separated list of excludes file pattern.
User property is: excludes.
goals String - The goals to run on the clean checkout of a project for the bootstrap goal. If none are specified, then the default goal for the project is executed. Multiple goals should be comma separated.
User property is: goals.
goalsDirectory String - The subdirectory (under the project directory) in which to run the goals. The project directory is the same as the checkout directory in most cases, but for some SCMs, it is a subdirectory of the checkout directory.
User property is: goalsDirectory.
includes String - Comma separated list of includes file pattern.
User property is: includes.
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.
privateKey String - The private key (used by java svn).
User property is: privateKey.
profiles String - A list of profiles to run with the goals. Multiple profiles must be comma separated with no spaces.
User property is: profiles.
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.
scmVersion String - The version (revision number/branch name/tag name).
User property is: scmVersion.
scmVersionType String - The version type (branch/tag/revision) of scmVersion.
User property is: scmVersionType.
skipCheckoutIfExists boolean - Skip checkout if checkoutDirectory exists.
Default value is: false.
User property is: skipCheckoutIfExists.
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.
useExport boolean - Use Export instead of checkout
Default value is: false.
User property is: useExport.
username String - The user name (used by svn, starteam and perforce protocol).
User property is: username.
workingDirectory File - The working directory.
User property is: workingDirectory.

Parameter Details

basedir:

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

checkoutDirectory:

The directory to checkout the sources to for the bootstrap and checkout goals.
  • Type: java.io.File
  • Required: No
  • User Property: checkoutDirectory
  • Default: ${project.build.directory}/checkout

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: connectionUrl
  • Default: ${project.scm.developerConnection}

excludes:

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

goals:

The goals to run on the clean checkout of a project for the bootstrap goal. If none are specified, then the default goal for the project is executed. Multiple goals should be comma separated.
  • Type: java.lang.String
  • Required: No
  • User Property: goals

goalsDirectory:

The subdirectory (under the project directory) in which to run the goals. The project directory is the same as the checkout directory in most cases, but for some SCMs, it is a subdirectory of the checkout directory.
  • Type: java.lang.String
  • Required: No
  • User Property: goalsDirectory

includes:

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

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

privateKey:

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

profiles:

A list of profiles to run with the goals. Multiple profiles must be comma separated with no spaces.
  • Type: java.lang.String
  • Required: No
  • User Property: profiles

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

scmVersion:

The version (revision number/branch name/tag name).
  • Type: java.lang.String
  • Required: No
  • User Property: scmVersion

scmVersionType:

The version type (branch/tag/revision) of scmVersion.
  • Type: java.lang.String
  • Required: No
  • User Property: scmVersionType

skipCheckoutIfExists:

Skip checkout if checkoutDirectory exists.
  • Type: boolean
  • Required: No
  • User Property: skipCheckoutIfExists
  • Default: false

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

useExport:

Use Export instead of checkout
  • Type: boolean
  • Required: No
  • User Property: useExport
  • Default: false

username:

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

workingDirectory:

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