com.github.danielflower.mavenplugins.release

Class BaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.danielflower.mavenplugins.release.BaseMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

NextMojo, ReleaseMojo

public abstract class BaseMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

Roland Hauser sourcepond@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	buildNumber The build number to use in the release version.
protected List<String>	modulesToForceRelease A module to force release on, even if no changes has been detected.
protected List<String>	modulesToRelease The modules to release, or no value to to release the project from the root pom, which is the default.
protected org.apache.maven.project.MavenProject	project The Maven Project.
protected List<org.apache.maven.project.MavenProject>	projects

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

ROLE

Constructor Summary

Constructors

Constructor and Description
BaseMojo()

Method Summary

Modifier and Type	Method and Description
protected void	configureJsch(org.apache.maven.plugin.logging.Log log)

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

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

execute

Field Detail

project

@Parameter(property="project",
           required=true,
           readonly=true,
           defaultValue="${project}")
protected org.apache.maven.project.MavenProject project

The Maven Project.

projects

@Parameter(property="projects",
           required=true,
           readonly=true,
           defaultValue="${reactorProjects}")
protected List<org.apache.maven.project.MavenProject> projects

buildNumber

@Parameter(property="buildNumber")
protected Long buildNumber

The build number to use in the release version. Given a snapshot version of "1.0-SNAPSHOT" and a buildNumber value of "2", the actual released version will be "1.0.2".

By default, the plugin will automatically find a suitable build number. It will start at version 0 and increment this with each release.

This can be specified using a command line parameter ("-DbuildNumber=2") or in this plugin's configuration.

modulesToRelease

@Parameter(alias="modulesToRelease",
           property="modulesToRelease")
protected List<String> modulesToRelease

The modules to release, or no value to to release the project from the root pom, which is the default. The selected module plus any other modules it needs will be built and released also. When run from the command line, this can be a comma-separated list of module names.

modulesToForceRelease

@Parameter(alias="forceRelease",
           property="forceRelease")
protected List<String> modulesToForceRelease

A module to force release on, even if no changes has been detected.

Constructor Detail

BaseMojo

public BaseMojo()

Method Detail

configureJsch

protected final void configureJsch(org.apache.maven.plugin.logging.Log log)