Class TagMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.TagMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="tag",
      aggregator=true)
public class TagMojo
extends AbstractScmMojo

Tag the project.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	addTimestamp	Use timestamp tagging.
private String	message	The message applied to the tag creation.
private boolean	pinExternals	Currently only implemented with Subversion.
private boolean	remoteTagging	Currently only implemented with svn scm.
private boolean	sign	Deprecated. since 2.2.1, use signOption instead
private CommandParameters.SignOption	signOption	Toggles the signing for the tag command (only applicable to SCMs that support signing).
private String	tag	The tag name.
private String	timestampFormat	Set the timestamp format.
private String	timestampPosition	Define the timestamp position (end or begin).
private String	timestampPrefix	Timestamp tag prefix.

Fields inherited from class AbstractScmMojo

VALID_VERSION_TYPES, VERSION_TYPE_BRANCH, VERSION_TYPE_REVISION, VERSION_TYPE_TAG

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
TagMojo(ScmManager manager, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class AbstractScmMojo

checkResult, getBasedir, getConnectionUrl, getExcludes, getFileSet, getIncludes, getScmManager, getScmRepository, getScmVersion, getWorkingDirectory, handleExcludesIncludesAfterCheckoutAndExport, setConnectionType, setConnectionUrl, setExcludes, setIncludes, setWorkingDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

tag

@Parameter(property="tag",
           required=true)
private String tag

The tag name.

message

@Parameter(property="message")
private String message

The message applied to the tag creation.

timestampFormat

@Parameter(property="timestampFormat",
           defaultValue="yyyyMMddHHmmss")
private String timestampFormat

Set the timestamp format.

addTimestamp

@Parameter(property="addTimestamp",
           defaultValue="false")
private boolean addTimestamp

Use timestamp tagging.

timestampPosition

@Parameter(property="timestampPosition",
           defaultValue="end")
private String timestampPosition

Define the timestamp position (end or begin).

timestampPrefix

@Parameter(property="timestampPrefix",
           defaultValue="-")
private String timestampPrefix

Timestamp tag prefix.

remoteTagging

@Parameter(property="remoteTagging",
           defaultValue="true")
private boolean 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)

Since:

1.2

pinExternals

@Parameter(property="pinExternals",
           defaultValue="false")
private boolean pinExternals

Currently only implemented with Subversion. Enable the "--pin-externals" option in svn copy commands which is new in Subversion 1.9.

Since:

1.11.0

sign

@Parameter(property="sign",
           defaultValue="false")
private boolean sign

Deprecated.

since 2.2.1, use signOption instead

Enable the "--sign" in Git. Same as signOption set to either CommandParameters.SignOption.FORCE_SIGN or CommandParameters.SignOption.DEFAULT.

Since:

1.11.0

signOption

@Parameter(property="signOption")
private CommandParameters.SignOption signOption

Toggles the signing for the tag command (only applicable to SCMs that support signing).

Since:

2.2.1

Constructor Details

TagMojo

@Inject
public TagMojo(ScmManager manager,
 org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractScmMojo

Throws:

org.apache.maven.plugin.MojoExecutionException