Required Parameters

Name	Type	Since	Description
basedir	File	-	The base directory.

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.
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.
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.
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.
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).
profiles	String	-	A list of profiles to run with the goals. Multiple profiles must be comma separated with no spaces.
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.
scmVersion	String	-	The version (revision number/branch name/tag name).
scmVersionType	String	-	The version type (branch/tag/revision) of scmVersion.
skipCheckoutIfExists	boolean	-	Skip checkout if checkoutDirectory exists. Default value is: false.
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).
useExport	boolean	-	Use Export instead of checkout
username	String	-	The user name (used by svn, starteam and perforce protocol).
workingDirectory	File	-	The working directory.

Parameter Details

basedir:

• Type: java.io.File
• Required: Yes
• Expression: ${basedir}

---

checkoutDirectory:

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

---

connectionType:

• Type: java.lang.String
• Required: No
• Expression: ${connectionType}
• Default: connection

---

connectionUrl:

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

---

developerConnectionUrl:

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

---

excludes:

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

---

goals:

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

---

goalsDirectory:

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

---

includes:

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

---

passphrase:

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

---

password:

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

---

privateKey:

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

---

profiles:

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

---

providerImplementations:

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

---

pushChanges:

• Type: boolean
• Since: 1.4
• Required: No
• Expression: ${pushChanges}
• Default: true

---

scmVersion:

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

---

scmVersionType:

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

---

skipCheckoutIfExists:

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

---

systemProperties:

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

---

tagBase:

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

---

useExport:

• Type: boolean
• Required: No
• Expression: ${useExport}

---

username:

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

---

workingDirectory:

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