com.atlassian.maven.plugins.jgitflow.mojo

Class AbstractJGitFlowMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.atlassian.maven.plugins.jgitflow.mojo.AbstractJGitFlowMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildNumberMojo, FeatureDeployMojo, FeatureFinishMojo, FeatureStartMojo, HotfixFinishMojo, HotfixStartMojo, ReleaseFinishMojo, ReleaseStartMojo

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

Since:

version

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowSnapshots Whether to allow SNAPSHOT dependencies.
protected boolean	allowUntracked Whether to allow untracked files when checking if the working tree is clean.
protected boolean	alwaysUpdateOrigin Whether to always overwrite the origin url in the .git/config file This is useful to ensure the proper origin url is used in CI environments
protected String	defaultOriginUrl Default url to use if origin remote is not found in .git/config.
protected boolean	enableSshAgent Whether to enable using an ssh-agent.
protected String	eol This can be used to force the type of line ending used when rewriting poms.
protected boolean	localOnly Whether to turn off all operations access the remote git repository.
protected boolean	offline Whether to turn off all operations that require network access.
protected String	password The password to use when using user/pass authentication
protected org.apache.maven.project.MavenProject	project
protected boolean	pullDevelop Whether to pull the develop branch when jgitflow is initialized
protected boolean	pullMaster Whether to pull the master branch when jgitflow is initialized
protected String	scmCommentPrefix The message prefix to use for all SCM changes.
protected String	scmCommentSuffix The message suffix to use for all SCM changes.
protected org.apache.maven.execution.MavenSession	session
protected String	username The username to use when using user/pass authentication

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJGitFlowMojo()

Method Summary

Modifier and Type	Method and Description
protected File	getBasedir()
ClassLoader	getClassloader(String classpath)
protected String	getClasspath()
MavenJGitFlowExtension	getExtensionInstance(String classname)
FlowInitContext	getFlowInitContext()
List<org.apache.maven.project.MavenProject>	getReactorProjects() Gets the list of projects in the build reactor.
boolean	isRemoteAllowed()
void	setBasedir(File basedir) Sets the base directory of the build.
void	setFlowInitContext(FlowInitContext flowInitContext)

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(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

enableSshAgent

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

Whether to enable using an ssh-agent.

allowSnapshots

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

Whether to allow SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT.

allowUntracked

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

Whether to allow untracked files when checking if the working tree is clean.

offline

@Parameter(property="offline",
           defaultValue="${settings.offline}")
protected boolean offline

Whether to turn off all operations that require network access.

NOTE: THIS IS NOT CURRENTLY IMPLEMENTED!

localOnly

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

Whether to turn off all operations access the remote git repository. This will still allow network access to download dependencies and such.

NOTE: THIS IS NOT CURRENTLY IMPLEMENTED!

defaultOriginUrl

@Parameter(property="defaultOriginUrl",
           defaultValue="")
protected String defaultOriginUrl

Default url to use if origin remote is not found in .git/config. This is highly useful for CI servers that don't do proper clones.

scmCommentPrefix

@Parameter(property="scmCommentPrefix",
           defaultValue="")
protected String scmCommentPrefix

The message prefix to use for all SCM changes.

scmCommentSuffix

@Parameter(property="scmCommentSuffix",
           defaultValue="")
protected String scmCommentSuffix

The message suffix to use for all SCM changes.

username

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

The username to use when using user/pass authentication

password

@Parameter(property="password",
           defaultValue="")
protected String password

The password to use when using user/pass authentication

alwaysUpdateOrigin

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

Whether to always overwrite the origin url in the .git/config file This is useful to ensure the proper origin url is used in CI environments

pullMaster

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

Whether to pull the master branch when jgitflow is initialized

pullDevelop

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

Whether to pull the develop branch when jgitflow is initialized

eol

@Parameter(defaultValue="",
           property="eol")
protected String eol

This can be used to force the type of line ending used when rewriting poms. If not set, blank or has an invalid value, the eol will be looked up from core.eol Valid values are: native, lf, crlf

Constructor Detail

AbstractJGitFlowMojo

public AbstractJGitFlowMojo()

Method Detail

getBasedir

protected final File getBasedir()

setBasedir

public void setBasedir(File basedir)

Sets the base directory of the build.

Parameters:

basedir - The build's base directory, must not be null.

getReactorProjects

public List<org.apache.maven.project.MavenProject> getReactorProjects()

Gets the list of projects in the build reactor.

Returns:

The list of reactor project, never null.

getFlowInitContext

public FlowInitContext getFlowInitContext()

setFlowInitContext

public void setFlowInitContext(FlowInitContext flowInitContext)

isRemoteAllowed

public boolean isRemoteAllowed()

getExtensionInstance

public MavenJGitFlowExtension getExtensionInstance(String classname)
                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getClassloader

public ClassLoader getClassloader(String classpath)

getClasspath

protected String getClasspath()
                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException