scm:tag
Full name:
org.apache.maven.plugins:maven-scm-plugin:2.2.0:tag
Description:
Tag the project.
Attributes:
- Requires a Maven project to be executed.
- Executes as an aggregator goal.
- 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: basedir |
<tag> |
String |
- |
The tag name. User Property: tag |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<addTimestamp> |
boolean |
- |
Use timestamp tagging. Default: falseUser Property: addTimestamp |
<connectionType> |
String |
- |
The type of connection to use (connection or developerConnection). Default: connectionUser Property: connectionType |
<connectionUrl> |
String |
- |
The SCM connection URL. Default: ${project.scm.connection}User Property: connectionUrl |
<developerConnectionUrl> |
String |
- |
The SCM connection URL for developers. Default: ${project.scm.developerConnection}User Property: developerConnectionUrl |
<excludes> |
String |
- |
Comma separated list of excludes file pattern. User Property: excludes |
<forceNoSign> |
boolean |
2.1.1 |
Enable the "--no-sign" in Git Default: falseUser Property: forceNoSign |
<includes> |
String |
- |
Comma separated list of includes file pattern. User Property: includes |
<message> |
String |
- |
The message applied to the tag creation. User Property: message |
<passphrase> |
String |
- |
The passphrase. See also: Authentication User Property: passphrase |
<password> |
String |
- |
The user password. See also: Authentication User Property: 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: falseUser Property: pinExternals |
<privateKey> |
String |
- |
The private key. See also: Authentication User Property: privateKey |
<providerImplementations> |
Map<String,String> |
- |
List of remapped provider implementations. Allows to bind a different implementation than the default one to a provider id. The key is the remapped provider id, the value is the default provider id the implementation is bound to. See also: Supported SCMs |
<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: trueUser Property: 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: trueUser Property: remoteTagging |
<serverId> |
String |
2.2.0 |
The server id of the server which provides the credentials for the SCM in the settings.xml file. If not set the default lookup uses the SCM URL to construct the server id like this: server-id=scm-host[":"scm-port].
Currently the POM does not allow to specify a server id for the SCM section. Explicit authentication information provided via See also: Authentication User Property: project.scm.id |
<sign> |
boolean |
1.11.0 |
Enable the "--sign" in Git Default: falseUser Property: sign |
<systemProperties> |
Properties |
- |
List of System properties to set before executing the SCM command. |
<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: tagBase |
<timestampFormat> |
String |
- |
Set the timestamp format. Default: yyyyMMddHHmmssUser Property: timestampFormat |
<timestampPosition> |
String |
- |
Define the timestamp position (end or begin). Default: endUser Property: timestampPosition |
<timestampPrefix> |
String |
- |
Timestamp tag prefix. Default: -User Property: timestampPrefix |
<username> |
String |
- |
The user name. See also: Authentication User Property: username |
<workItem> |
String |
1.9.5 |
Deprecated. No reason given A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation. User Property: workItem |
<workingDirectory> |
File |
- |
The working directory. User Property: workingDirectory |
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
<forceNoSign>
Enable the "--no-sign" in Git
- Type:
boolean - Since:
2.1.1 - Required:
No - User Property:
forceNoSign - Default:
false
<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.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
passphrase
<password>
The user password.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
password
<pinExternals>
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
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.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
privateKey
<providerImplementations>
List of remapped provider implementations. Allows to bind a different implementation than the default one to a provider id. The key is the remapped provider id, the value is the default provider id the implementation is bound to.
See also: Supported SCMs
See also: Supported SCMs
- 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
<serverId>
The server id of the server which provides the credentials for the SCM in the settings.xml file. If not set the default lookup uses the SCM URL to construct the server id like this:
See also: Authentication
server-id=scm-host[":"scm-port].
Currently the POM does not allow to specify a server id for the SCM section.
Explicit authentication information provided via username, password or privateKey will take precedence.
See also: Authentication
- Type:
java.lang.String - Since:
2.2.0 - Required:
No - User Property:
project.scm.id
<sign>
Enable the "--sign" in Git
- Type:
boolean - Since:
1.11.0 - Required:
No - User Property:
sign - Default:
false
<systemProperties>
List of System properties to set before executing the SCM command.
- Type:
java.util.Properties - Required:
No
<tag>
The tag name.
- Type:
java.lang.String - Required:
Yes - User Property:
tag
<tagBase>
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).
- Type:
java.lang.String - Required:
No - User Property:
tagBase
<timestampFormat>
Set the timestamp format.
- Type:
java.lang.String - Required:
No - User Property:
timestampFormat - Default:
yyyyMMddHHmmss
<timestampPosition>
Define the timestamp position (end or begin).
- Type:
java.lang.String - Required:
No - User Property:
timestampPosition - Default:
end
<timestampPrefix>
Timestamp tag prefix.
- Type:
java.lang.String - Required:
No - User Property:
timestampPrefix - Default:
-
<username>
The user name.
See also: Authentication
See also: Authentication
- Type:
java.lang.String - Required:
No - User Property:
username
<workItem>
Deprecated.
No reason given
No reason given
A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.
- Type:
java.lang.String - Since:
1.9.5 - Required:
No - User Property:
workItem
<workingDirectory>
The working directory.
- Type:
java.io.File - Required:
No - User Property:
workingDirectory