org.alfresco.maven.plugin

Class VersionMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.alfresco.maven.plugin.VersionMojo

All Implemented Interfaces:

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

public class VersionMojo
extends org.apache.maven.plugin.AbstractMojo

Removes -SNAPSHOT suffix from the version number (if present), optionally replacing it with a timestamp. The result is provided in the Maven property ${noSnapshotVersion} (name can be changed using myCustomVersion). This feature is mostly needed to avoid Alfresco failing when installing AMP modules with non-numeric versions.

Since:

1.0

Version:

$Id:$

Field Summary

Fields

Modifier and Type	Field and Description
protected String	customVersionSuffix Allows to append a custom (numeric) value to the current artifact's version, i.e.
protected org.apache.maven.project.MavenProject	project [Read Only] The Maven project.
protected String	snapshotSuffix The snapshotSuffix used to identify and strip the -SNAPSHOT version suffix See issue https://issues.alfresco.com/jira/browse/ENH-1232
protected boolean	snapshotToTimestamp Enable this option in order to replace -SNAPSHOT with the currentTimestamp of the artifact creation See issue https://issues.alfresco.com/jira/browse/ENH-1232
protected String	version [Read Only] Current version of the project

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

ROLE

Constructor Summary

Constructors

Constructor and Description
VersionMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected String	getNormalizedVersion() Normalizes the project's version following 2 patterns - Remove the -SNAPSHOT suffix, if present - (Optionally) append the timestamp to the version, if -SNAPSHOT is present - (Optionally) append the build number to the version

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

snapshotSuffix

protected String snapshotSuffix

The snapshotSuffix used to identify and strip the -SNAPSHOT version suffix See issue https://issues.alfresco.com/jira/browse/ENH-1232

snapshotToTimestamp

protected boolean snapshotToTimestamp

Enable this option in order to replace -SNAPSHOT with the currentTimestamp of the artifact creation See issue https://issues.alfresco.com/jira/browse/ENH-1232

customVersionSuffix

protected String customVersionSuffix

Allows to append a custom (numeric) value to the current artifact's version, i.e. appending the SCM build number can be accomplished defining ${buildnumber} in the plugin configuration.

project

protected org.apache.maven.project.MavenProject project

[Read Only] The Maven project.

version

protected String version

[Read Only] Current version of the project

Constructor Detail

VersionMojo

public VersionMojo()

Method Detail

getNormalizedVersion

protected String getNormalizedVersion()

Normalizes the project's version following 2 patterns - Remove the -SNAPSHOT suffix, if present - (Optionally) append the timestamp to the version, if -SNAPSHOT is present - (Optionally) append the build number to the version

Returns:

the current project's version normalized

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException