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: developerConnectionUrl.
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.
mavenHome	File	-	The path where your maven is installed Default value is: ${maven.home}. User property is: mavenHome.
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.
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:

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

---

checkoutDirectory:

• Type: java.io.File
• Required: No
• User Property: checkoutDirectory
• Default: ${project.build.directory}/checkout

---

connectionType:

• Type: java.lang.String
• Required: No
• User Property: connectionType
• Default: connection

---

connectionUrl:

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

---

developerConnectionUrl:

• Type: java.lang.String
• Required: No
• User Property: developerConnectionUrl
• Default: ${project.scm.developerConnection}

---

excludes:

• Type: java.lang.String
• Required: No
• User Property: excludes

---

goals:

• Type: java.lang.String
• Required: No
• User Property: goals

---

goalsDirectory:

• Type: java.lang.String
• Required: No
• User Property: goalsDirectory

---

includes:

• Type: java.lang.String
• Required: No
• User Property: includes

---

mavenHome:

• Type: java.io.File
• Required: No
• User Property: mavenHome
• Default: ${maven.home}

---

passphrase:

• Type: java.lang.String
• Required: No
• User Property: passphrase

---

password:

• Type: java.lang.String
• Required: No
• User Property: password

---

privateKey:

• Type: java.lang.String
• Required: No
• User Property: privateKey

---

profiles:

• Type: java.lang.String
• Required: No
• User Property: profiles

---

providerImplementations:

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

---

pushChanges:

• Type: boolean
• Since: 1.4
• Required: No
• User Property: pushChanges
• Default: true

---

scmVersion:

• Type: java.lang.String
• Required: No
• User Property: scmVersion

---

scmVersionType:

• Type: java.lang.String
• Required: No
• User Property: scmVersionType

---

skipCheckoutIfExists:

• Type: boolean
• Required: No
• User Property: skipCheckoutIfExists
• Default: false

---

systemProperties:

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

---

tagBase:

• Type: java.lang.String
• Required: No
• User Property: tagBase

---

useExport:

• Type: boolean
• Required: No
• User Property: useExport
• Default: false

---

username:

• Type: java.lang.String
• Required: No
• User Property: username

---

workItem:

• Type: java.lang.String
• Since: 1.9.5
• Required: No
• User Property: workItem

---

workingDirectory:

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