com.amashchenko.maven.plugin.gitflow

Class AbstractGitFlowMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.amashchenko.maven.plugin.gitflow.AbstractGitFlowMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

GitFlowFeatureFinishMojo, GitFlowFeatureStartMojo, GitFlowHotfixFinishMojo, GitFlowHotfixStartMojo, GitFlowReleaseFinishMojo, GitFlowReleaseMojo, GitFlowReleaseStartMojo, GitFlowSupportStartMojo

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

Abstract git flow mojo.

Field Summary

Fields

Modifier and Type	Field and Description
protected CommitMessages	commitMessages Git commit messages.
protected boolean	fetchRemote Whether to fetch remote branch and compare it with the local one.
protected GitFlowConfig	gitFlowConfig Git flow configuration.
protected boolean	installProject Whether to call Maven install goal during the mojo execution.
protected static String	LS System line separator.
protected org.apache.maven.execution.MavenSession	mavenSession Maven session.
protected org.codehaus.plexus.components.interactivity.Prompter	prompter Default prompter.
protected org.apache.maven.settings.Settings	settings Maven settings.
protected boolean	tychoBuild Whether this is Tycho build.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGitFlowMojo()

Method Summary

Modifier and Type	Method and Description
protected void	checkSnapshotDependencies()
protected void	checkUncommittedChanges() Checks uncommitted changes.
protected String	getCurrentProjectVersion() Gets current project version evaluating pom.xml This implementation takes care of version based on properties or other runtime evaluation needed.
protected void	gitBranchDelete(String branchName) Executes git branch -d.
protected void	gitBranchDeleteForce(String branchName) Executes git branch -D.
protected boolean	gitCheckBranchExists(String branchName) Checks if local branch with given name exists.
protected void	gitCheckout(String branchName) Executes git checkout.
protected boolean	gitCheckTagExists(String tagName) Checks if local tag with given name exists.
protected void	gitCommit(String message) Executes git commit -a -m.
protected void	gitCommit(String message, Map<String,String> messageProperties) Executes git commit -a -m, replacing @{map.key} with map.value.
protected void	gitCreateAndCheckout(String newBranchName, String fromBranchName) Executes git checkout -b.
protected void	gitCreateBranch(String newBranchName, String fromBranchName) Executes git branch.
protected void	gitFetchRemoteAndCompare(String branchName) Executes git fetch and compares local branch with the remote.
protected void	gitFetchRemoteAndCreate(String branchName) Fetches and checkouts from remote if local branch doesn't exist.
protected String	gitFindBranches(String branchName, boolean firstMatch) Executes git for-each-ref with refname:short format.
protected String	gitFindLastTag() Executes git for-each-ref to get the last tag.
protected String	gitFindTags() Executes git for-each-ref to get all tags.
protected void	gitMerge(String branchName, boolean rebase, boolean noff, boolean ffonly, String message, Map<String,String> messageProperties) Executes git rebase or git merge --ff-only or git merge --no-ff or git merge.
protected void	gitMergeNoff(String branchName) Executes git merge --no-ff.
protected void	gitMergeSquash(String branchName) Executes git merge --squash.
protected void	gitPush(String branchName, boolean pushTags) Executes git push, optionally with the --follow-tags argument.
protected void	gitPushDelete(String branchName)
protected void	gitTag(String tagName, String message, boolean gpgSignTag, Map<String,String> messageProperties) Executes git tag -a [-s] -m.
protected void	initGitFlowConfig() Executes git config commands to set Git Flow configuration.
protected void	mvnCleanInstall() Executes mvn clean install.
protected void	mvnCleanTest() Executes mvn clean test.
protected void	mvnRun(String goals) Executes Maven goals.
protected void	mvnSetVersions(String version) Executes 'set' goal of versions-maven-plugin or 'set-version' of tycho-versions-plugin in case it is tycho build.
protected boolean	notSameProdDevName() Compares the production branch name with the development branch name.
void	setArgLine(String argLine)
protected void	validateConfiguration(String... params) Validates plugin configuration.
protected boolean	validBranchName(String branchName) Checks if branch name is acceptable.

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

LS

protected static final String LS

System line separator.

gitFlowConfig

@Parameter(defaultValue="${gitFlowConfig}")
protected GitFlowConfig gitFlowConfig

Git flow configuration.

commitMessages

@Parameter(defaultValue="${commitMessages}")
protected CommitMessages commitMessages

Git commit messages.

Since:

1.2.1

tychoBuild

@Parameter(defaultValue="false")
protected boolean tychoBuild

Whether this is Tycho build.

Since:

1.1.0

installProject

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

Whether to call Maven install goal during the mojo execution.

Since:

1.0.5

fetchRemote

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

Whether to fetch remote branch and compare it with the local one.

Since:

1.3.0

mavenSession

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

Maven session.

prompter

@Component
protected org.codehaus.plexus.components.interactivity.Prompter prompter

Default prompter.

settings

@Parameter(defaultValue="${settings}",
           readonly=true)
protected org.apache.maven.settings.Settings settings

Maven settings.

Constructor Detail

AbstractGitFlowMojo

public AbstractGitFlowMojo()

Method Detail

validateConfiguration

protected void validateConfiguration(String... params)
                              throws org.apache.maven.plugin.MojoFailureException

Validates plugin configuration. Throws exception if configuration is not valid.

Parameters:

params - Configuration parameters to validate.

Throws:

org.apache.maven.plugin.MojoFailureException - If configuration is not valid.

getCurrentProjectVersion

protected String getCurrentProjectVersion()
                                   throws org.apache.maven.plugin.MojoFailureException,
                                          org.codehaus.plexus.util.cli.CommandLineException

Gets current project version evaluating pom.xml This implementation takes care of version based on properties or other runtime evaluation needed. Under the hood it delegates to org.apache.maven.plugins:maven-help-plugin which is the same used for effective-pom

Returns:

Current project version.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

notSameProdDevName

protected boolean notSameProdDevName()

Compares the production branch name with the development branch name.

Returns:

true if the production branch name is different from the development branch name, false otherwise.

checkUncommittedChanges

protected void checkUncommittedChanges()
                                throws org.apache.maven.plugin.MojoFailureException,
                                       org.codehaus.plexus.util.cli.CommandLineException

Checks uncommitted changes.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

checkSnapshotDependencies

protected void checkSnapshotDependencies()
                                  throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

validBranchName

protected boolean validBranchName(String branchName)
                           throws org.apache.maven.plugin.MojoFailureException,
                                  org.codehaus.plexus.util.cli.CommandLineException

Checks if branch name is acceptable.

Parameters:

branchName - Branch name to check.

Returns:

true when name is valid, false otherwise.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

initGitFlowConfig

protected void initGitFlowConfig()
                          throws org.apache.maven.plugin.MojoFailureException,
                                 org.codehaus.plexus.util.cli.CommandLineException

Executes git config commands to set Git Flow configuration.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitFindBranches

protected String gitFindBranches(String branchName,
                                 boolean firstMatch)
                          throws org.apache.maven.plugin.MojoFailureException,
                                 org.codehaus.plexus.util.cli.CommandLineException

Executes git for-each-ref with refname:short format.

Parameters:

branchName - Branch name to find.

firstMatch - Return first match.

Returns:

Branch names which matches refs/heads/{branchName}*.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitFindTags

protected String gitFindTags()
                      throws org.apache.maven.plugin.MojoFailureException,
                             org.codehaus.plexus.util.cli.CommandLineException

Executes git for-each-ref to get all tags.

Returns:

Git tags.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitFindLastTag

protected String gitFindLastTag()
                         throws org.apache.maven.plugin.MojoFailureException,
                                org.codehaus.plexus.util.cli.CommandLineException

Executes git for-each-ref to get the last tag.

Returns:

Last tag.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitCheckBranchExists

protected boolean gitCheckBranchExists(String branchName)
                                throws org.apache.maven.plugin.MojoFailureException,
                                       org.codehaus.plexus.util.cli.CommandLineException

Checks if local branch with given name exists.

Parameters:

branchName - Name of the branch to check.

Returns:

true if local branch exists, false otherwise.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitCheckTagExists

protected boolean gitCheckTagExists(String tagName)
                             throws org.apache.maven.plugin.MojoFailureException,
                                    org.codehaus.plexus.util.cli.CommandLineException

Checks if local tag with given name exists.

Parameters:

tagName - Name of the tag to check.

Returns:

true if local tag exists, false otherwise.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitCheckout

protected void gitCheckout(String branchName)
                    throws org.apache.maven.plugin.MojoFailureException,
                           org.codehaus.plexus.util.cli.CommandLineException

Executes git checkout.

Parameters:

branchName - Branch name to checkout.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitCreateAndCheckout

protected void gitCreateAndCheckout(String newBranchName,
                                    String fromBranchName)
                             throws org.apache.maven.plugin.MojoFailureException,
                                    org.codehaus.plexus.util.cli.CommandLineException

Executes git checkout -b.

Parameters:

newBranchName - Create branch with this name.

fromBranchName - Create branch from this branch.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitCreateBranch

protected void gitCreateBranch(String newBranchName,
                               String fromBranchName)
                        throws org.apache.maven.plugin.MojoFailureException,
                               org.codehaus.plexus.util.cli.CommandLineException

Executes git branch.

Parameters:

newBranchName - Create branch with this name.

fromBranchName - Create branch from this branch.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitCommit

protected void gitCommit(String message)
                  throws org.apache.maven.plugin.MojoFailureException,
                         org.codehaus.plexus.util.cli.CommandLineException

Executes git commit -a -m.

Parameters:

message - Commit message.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitCommit

protected void gitCommit(String message,
                         Map<String,String> messageProperties)
                  throws org.apache.maven.plugin.MojoFailureException,
                         org.codehaus.plexus.util.cli.CommandLineException

Executes git commit -a -m, replacing @{map.key} with map.value.

Parameters:

message - Commit message.

messageProperties - Properties to replace in message.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitMerge

protected void gitMerge(String branchName,
                        boolean rebase,
                        boolean noff,
                        boolean ffonly,
                        String message,
                        Map<String,String> messageProperties)
                 throws org.apache.maven.plugin.MojoFailureException,
                        org.codehaus.plexus.util.cli.CommandLineException

Executes git rebase or git merge --ff-only or git merge --no-ff or git merge.

Parameters:

branchName - Branch name to merge.

rebase - Do rebase.

noff - Merge with --no-ff.

ffonly - Merge with --ff-only.

message - Merge commit message.

messageProperties - Properties to replace in message.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitMergeNoff

protected void gitMergeNoff(String branchName)
                     throws org.apache.maven.plugin.MojoFailureException,
                            org.codehaus.plexus.util.cli.CommandLineException

Executes git merge --no-ff.

Parameters:

branchName - Branch name to merge.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitMergeSquash

protected void gitMergeSquash(String branchName)
                       throws org.apache.maven.plugin.MojoFailureException,
                              org.codehaus.plexus.util.cli.CommandLineException

Executes git merge --squash.

Parameters:

branchName - Branch name to merge.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitTag

protected void gitTag(String tagName,
                      String message,
                      boolean gpgSignTag,
                      Map<String,String> messageProperties)
               throws org.apache.maven.plugin.MojoFailureException,
                      org.codehaus.plexus.util.cli.CommandLineException

Executes git tag -a [-s] -m.

Parameters:

tagName - Name of the tag.

message - Tag message.

gpgSignTag - Make a GPG-signed tag.

messageProperties - Properties to replace in message.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitBranchDelete

protected void gitBranchDelete(String branchName)
                        throws org.apache.maven.plugin.MojoFailureException,
                               org.codehaus.plexus.util.cli.CommandLineException

Executes git branch -d.

Parameters:

branchName - Branch name to delete.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitBranchDeleteForce

protected void gitBranchDeleteForce(String branchName)
                             throws org.apache.maven.plugin.MojoFailureException,
                                    org.codehaus.plexus.util.cli.CommandLineException

Executes git branch -D.

Parameters:

branchName - Branch name to delete.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitFetchRemoteAndCreate

protected void gitFetchRemoteAndCreate(String branchName)
                                throws org.apache.maven.plugin.MojoFailureException,
                                       org.codehaus.plexus.util.cli.CommandLineException

Fetches and checkouts from remote if local branch doesn't exist.

Parameters:

branchName - Branch name to check.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitFetchRemoteAndCompare

protected void gitFetchRemoteAndCompare(String branchName)
                                 throws org.apache.maven.plugin.MojoFailureException,
                                        org.codehaus.plexus.util.cli.CommandLineException

Executes git fetch and compares local branch with the remote.

Parameters:

branchName - Branch name to fetch and compare.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitPush

protected void gitPush(String branchName,
                       boolean pushTags)
                throws org.apache.maven.plugin.MojoFailureException,
                       org.codehaus.plexus.util.cli.CommandLineException

Executes git push, optionally with the --follow-tags argument.

Parameters:

branchName - Branch name to push.

pushTags - If true adds --follow-tags argument to the git push command.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

gitPushDelete

protected void gitPushDelete(String branchName)
                      throws org.apache.maven.plugin.MojoFailureException,
                             org.codehaus.plexus.util.cli.CommandLineException

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

mvnSetVersions

protected void mvnSetVersions(String version)
                       throws org.apache.maven.plugin.MojoFailureException,
                              org.codehaus.plexus.util.cli.CommandLineException

Executes 'set' goal of versions-maven-plugin or 'set-version' of tycho-versions-plugin in case it is tycho build.

Parameters:

version - New version to set.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

mvnCleanTest

protected void mvnCleanTest()
                     throws org.apache.maven.plugin.MojoFailureException,
                            org.codehaus.plexus.util.cli.CommandLineException

Executes mvn clean test.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

mvnCleanInstall

protected void mvnCleanInstall()
                        throws org.apache.maven.plugin.MojoFailureException,
                               org.codehaus.plexus.util.cli.CommandLineException

Executes mvn clean install.

Throws:

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.util.cli.CommandLineException

mvnRun

protected void mvnRun(String goals)
               throws Exception

Executes Maven goals.

Parameters:

goals - The goals to execute.

Throws:

Exception

setArgLine

public void setArgLine(String argLine)