Required Parameters

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

Optional Parameters

Name	Type	Since	Description
connectionType	String	1.2	The type of connection to use (connection or developerConnection). Default value is: connection. User property is: connectionType.
connectionUrl	String	1.2	The SCM connection URL. Default value is: ${project.scm.connection}. User property is: connectionUrl.
developerConnectionUrl	String	1.2	The SCM connection URL for developers. Default value is: ${project.scm.developerConnection}. User property is: developerConnectionUrl.
errorMessage	String	1.2	Custom error message Default value is: The build will stop as there is local modifications. User property is: scm.checkLocalModification.errorMessage.
excludes	String	1.2	Comma separated list of excludes file pattern. User property is: excludes.
includes	String	1.2	Comma separated list of includes file pattern. User property is: includes.
passphrase	String	1.2	The passphrase (used by java svn). User property is: passphrase.
password	String	1.2	The user password (used by svn, starteam and perforce protocol). User property is: password.
privateKey	String	1.2	The private key (used by java svn). User property is: privateKey.
providerImplementations	Map	1.2	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.
skip	boolean	1.2	Skip the check for local modifications if set to true. Default value is: false. User property is: scm.checkLocalModification.skip.
systemProperties	Properties	1.2	List of System properties to pass to the JUnit tests.
tagBase	String	1.2	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	1.2	The user name (used by svn, starteam and perforce protocol). User property is: username.
workingDirectory	File	1.2	The working directory. User property is: workingDirectory.

Parameter Details

basedir:

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

---

connectionType:

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

---

connectionUrl:

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

---

developerConnectionUrl:

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

---

errorMessage:

• Type: java.lang.String
• Since: 1.2
• Required: No
• User Property: scm.checkLocalModification.errorMessage
• Default: The build will stop as there is local modifications

---

excludes:

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

---

includes:

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

---

passphrase:

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

---

password:

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

---

privateKey:

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

---

providerImplementations:

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

---

pushChanges:

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

---

skip:

• Type: boolean
• Since: 1.2
• Required: No
• User Property: scm.checkLocalModification.skip
• Default: false

---

systemProperties:

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

---

tagBase:

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

---

username:

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

---

workingDirectory:

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