org.apache.maven.plugin.cxx

Class AbstractPerformBranchReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.cxx.AbstractCxxMojo

org.apache.maven.plugin.cxx.AbstractPerformBranchReleaseMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

PerformBranchMojo, PerformReleaseMojo

public abstract class AbstractPerformBranchReleaseMojo
extends AbstractCxxMojo

Branch a project in SCM

Since:

0.0.6

Version:

Author:

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addSchema Whether to add a XML schema to the POM if it was previously missing on.
protected String	artifactId new artifact id, if provided
protected boolean	autoVersionSubmodules Whether to automatically assign submodules the parent (main) version.
protected boolean	dryRun Dry run: don't checkin or tag anything in the scm repository, or modify the checkout.
protected File	javaHome The JAVA_HOME parameter to use for forked Maven invocations.
protected File	localRepoDirectory The command-line local repository directory in use for this build (if specified).
protected File	mavenHome The M2_HOME parameter to use for forked Maven invocations.
protected CxxReleaseManager	releaseManager phases manager.
protected String	settingsServerId The server id to use in maven settings to retrieve credential.
protected boolean	snapshotDevelopmentVersion Shall developpment version use -SNAPSHOT suffix
protected boolean	updateDependencies Whether to update dependencies version to the next development version.
protected String	username The user name (used by svn).
protected File	workingDirectory The checkout directory.

Fields inherited from class org.apache.maven.plugin.cxx.AbstractCxxMojo

basedir, project, reactorProjects, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractPerformBranchReleaseMojo()

Method Summary

Modifier and Type	Method and Description
protected CxxReleaseDescriptor	createReleaseDescriptor() Creates the release descriptor from the various goal parameters.
protected org.apache.maven.shared.release.env.ReleaseEnvironment	getReleaseEnvironment() Gets the enviroment settings configured for this release.

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

mavenHome

@Parameter(defaultValue="${maven.home}")
protected File mavenHome

The M2_HOME parameter to use for forked Maven invocations.

Since:

0.0.6

javaHome

@Parameter(defaultValue="${java.home}")
protected File javaHome

The JAVA_HOME parameter to use for forked Maven invocations.

Since:

0.0.6

localRepoDirectory

@Parameter(defaultValue="${maven.repo.local}")
protected File localRepoDirectory

The command-line local repository directory in use for this build (if specified).

Since:

0.0.6

username

@Parameter(property="username")
protected String username

The user name (used by svn). You may use maven setting to store username. See http://maven.apache.org/guides/mini/guide-encryption.html

Since:

0.0.6

settingsServerId

@Parameter(property="settingsServerId")
protected String settingsServerId

The server id to use in maven settings to retrieve credential. Optionnal, by defaut each scm url "hostname[:port]" is taken as server id to search potential credentials in maven settings See http://maven.apache.org/guides/mini/guide-encryption.html

Since:

0.0.6

dryRun

@Parameter(defaultValue="false",
           property="dryRun")
protected boolean dryRun

Dry run: don't checkin or tag anything in the scm repository, or modify the checkout. Running mvn -DdryRun=true cxx:branch is useful in order to check that modifications to poms and scm operations (only listed on the console) are working as expected. Modified POMs are written alongside the originals without modifying them.

Since:

0.0.6

snapshotDevelopmentVersion

@Parameter(defaultValue="false",
           property="snapshotDevelopmentVersion")
protected boolean snapshotDevelopmentVersion

Shall developpment version use -SNAPSHOT suffix

artifactId

@Parameter(property="artifactId")
protected String artifactId

new artifact id, if provided

autoVersionSubmodules

@Parameter(defaultValue="false",
           property="autoVersionSubmodules")
protected boolean autoVersionSubmodules

Whether to automatically assign submodules the parent (main) version. If set to true, each submodule (if any) will be update to computed main version If set to false : - the user will be prompted for each submodules version if settings.isInteractiveMode()/-B,--batch-mode flag not set - auto-computed if !settings.isInteractiveMode()/-B,--batch-mode flag set !!PLUS!! : Submodule version are updated only if they are "real" child of main module, according to SCM tree. Aka. Only and only if : - submodule dir is under scm configuration - submodule dir is not an external dir - (futur ?) submodule dir is an external dir AND settings.isInteractiveMode()/-B,--batch-mode flag not set AND user confirm branch and version update

Since:

0.0.6

updateDependencies

@Parameter(defaultValue="true",
           property="updateDependencies")
protected boolean updateDependencies

Whether to update dependencies version to the next development version.

Since:

0.0.6

addSchema

@Parameter(defaultValue="true",
           property="addSchema")
protected boolean addSchema

Whether to add a XML schema to the POM if it was previously missing on.

Since:

0.0.6

workingDirectory

@Parameter(defaultValue="${project.build.directory}/checkout",
           property="workingDirectory",
           required=true)
protected File workingDirectory

The checkout directory.

releaseManager

@Component
protected CxxReleaseManager releaseManager

phases manager.

Constructor Detail

AbstractPerformBranchReleaseMojo

public AbstractPerformBranchReleaseMojo()

Method Detail

getReleaseEnvironment

protected org.apache.maven.shared.release.env.ReleaseEnvironment getReleaseEnvironment()

Gets the enviroment settings configured for this release.

Returns:

The release environment, never null.

createReleaseDescriptor

protected CxxReleaseDescriptor createReleaseDescriptor()

Creates the release descriptor from the various goal parameters.

Returns:

The release descriptor, never null.