Required Parameters

Name	Type	Since	Description
basedir	File	-	The base directory.
tag	String	-	The tag name.

Optional Parameters

Name	Type	Since	Description
addTimestamp	boolean	-	Use timestamp tagging. Default value is: false.
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.
includes	String	-	Comma separated list of includes file pattern.
message	String	-	The message applied to the tag creation.
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).
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.
remoteTagging	boolean	1.2	currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (http://jira.codehaus.org/browse/SCM-406) Default value is: true.
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).
timestampFormat	String	-	Set the timestamp format. Default value is: yyyyMMddHHmmss.
timestampPosition	String	-	Define the timestamp position (end or begin). Default value is: end.
timestampPrefix	String	-	Timestamp tag prefix. Default value is: -.
username	String	-	The user name (used by svn, starteam and perforce protocol).
workingDirectory	File	-	The working directory.

Parameter Details

addTimestamp:

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

---

basedir:

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

---

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}

---

includes:

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

---

message:

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

---

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}

---

providerImplementations:

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

---

pushChanges:

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

---

remoteTagging:

• Type: boolean
• Since: 1.2
• Required: No
• Expression: ${remoteTagging}
• Default: true

---

systemProperties:

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

---

tag:

• Type: java.lang.String
• Required: Yes
• Expression: ${tag}

---

tagBase:

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

---

timestampFormat:

• Type: java.lang.String
• Required: No
• Expression: ${timestampFormat}
• Default: yyyyMMddHHmmss

---

timestampPosition:

• Type: java.lang.String
• Required: No
• Expression: ${timestampPosition}
• Default: end

---

timestampPrefix:

• Type: java.lang.String
• Required: No
• Expression: ${timestampPrefix}
• Default: -

---

username:

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

---

workingDirectory:

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