Maven SCM plugin

scm:tag

Full name:

org.apache.maven.plugins:maven-scm-plugin:2.0.1:tag

Description:

Tag the project.

Attributes:

Requires a Maven project to be executed.
Executes as an aggregator plugin.
The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name	Type	Since	Description
`<basedir>`	`File`	`-`	The base directory. User property is: `basedir`.
`<tag>`	`String`	`-`	The tag name. User property is: `tag`.

Optional Parameters

Name	Type	Since	Description
`<addTimestamp>`	`boolean`	`-`	Use timestamp tagging. Default value is: `false`. User property is: `addTimestamp`.
`<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`.
`<includes>`	`String`	`-`	Comma separated list of includes file pattern. User property is: `includes`.
`<message>`	`String`	`-`	The message applied to the tag creation. User property is: `message`.
`<passphrase>`	`String`	`-`	The passphrase. User property is: `passphrase`.
`<password>`	`String`	`-`	The user password. User property is: `password`.
`<pinExternals>`	`boolean`	`1.11.0`	Currently only implemented with Subversion. Enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9. See also: https://subversion.apache.org/docs/release-notes/1.9.html Default value is: `false`. User property is: `pinExternals`.
`<privateKey>`	`String`	`-`	The private key. User property is: `privateKey`.
`<providerImplementations>`	`Map<String,String>`	`-`	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`.
`<remoteTagging>`	`boolean`	`1.2`	currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406) Default value is: `true`. User property is: `remoteTagging`.
`<sign>`	`boolean`	`1.11.0`	Enable the "--sign" in Git Default value is: `false`. User property is: `sign`.
`<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`.
`<timestampFormat>`	`String`	`-`	Set the timestamp format. Default value is: `yyyyMMddHHmmss`. User property is: `timestampFormat`.
`<timestampPosition>`	`String`	`-`	Define the timestamp position (end or begin). Default value is: `end`. User property is: `timestampPosition`.
`<timestampPrefix>`	`String`	`-`	Timestamp tag prefix. Default value is: `-`. User property is: `timestampPrefix`.
`<username>`	`String`	`-`	The user name. User property is: `username`.
`<workingDirectory>`	`File`	`-`	The working directory. User property is: `workingDirectory`.
`<workItem>`	`String`	`1.9.5`	Deprecated. A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation. User property is: `workItem`.

Parameter Details

<addTimestamp>

Use timestamp tagging.

Type: boolean
Required: No
User Property: addTimestamp
Default: false

<basedir>

The base directory.

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

<connectionType>

The type of connection to use (connection or developerConnection).

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

<connectionUrl>

The SCM connection URL.

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

<developerConnectionUrl>

The SCM connection URL for developers.

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

<excludes>

Comma separated list of excludes file pattern.

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

<includes>

Comma separated list of includes file pattern.

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

<message>

The message applied to the tag creation.

Type: java.lang.String
Required: No
User Property: message

<passphrase>

The passphrase.

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

<password>

The user password.

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

Currently only implemented with Subversion. Enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9.
See also: https://subversion.apache.org/docs/release-notes/1.9.html

Type: boolean
Since: 1.11.0
Required: No
User Property: pinExternals
Default: false

<privateKey>

The private key.

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

<providerImplementations>

List of provider implementations.

Type: java.util.Map<java.lang.String, java.lang.String>
Required: No

<pushChanges>

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.

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

<remoteTagging>

currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)

Type: boolean
Since: 1.2
Required: No
User Property: remoteTagging
Default: true