Required Parameters

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

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.
dateFormat	String	-	Date Format in changelog output of scm tool. User property is: dateFormat.
developerConnectionUrl	String	-	The SCM connection URL for developers. Default value is: ${project.scm.developerConnection}. User property is: developerConnectionUrl.
endDate	String	-	End Date. User property is: endDate.
endScmVersion	String	-	End Scm Version. User property is: endScmVersion.
endScmVersionType	String	-	End Scm Version Type. User property is: endScmVersionType.
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.
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.
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) of scmVersion. User property is: scmVersionType.
startDate	String	-	Start Date. User property is: startDate.
startScmVersion	String	-	Start Scm Version. User property is: startScmVersion.
startScmVersionType	String	-	Start Scm Version Type. User property is: startScmVersionType.
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.
userDateFormat	String	-	Date format to use for the specified startDate and/or endDate. Default value is: yyyy-MM-dd. User property is: userDateFormat.
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

---

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}

---

dateFormat:

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

---

developerConnectionUrl:

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

---

endDate:

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

---

endScmVersion:

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

---

endScmVersionType:

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

---

excludes:

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

---

includes:

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

---

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

---

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

---

startDate:

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

---

startScmVersion:

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

---

startScmVersionType:

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

---

systemProperties:

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

---

tagBase:

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

---

userDateFormat:

• Type: java.lang.String
• Required: No
• User Property: userDateFormat
• Default: yyyy-MM-dd

---

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