Package com.github.koraktor.mavanagaiata.mojo

Class CheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

com.github.koraktor.mavanagaiata.mojo.CheckMojo

All Implemented Interfaces:

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

@Mojo(name="check",
      defaultPhase=VALIDATE,
      threadSafe=true)
public class CheckMojo
extends AbstractGitMojo

This goal checks various aspects of a Git repository to ensure it is in a valid state prior to a build

The following checks are available:

• Clean working directory (enabled by default)
• Tagged commit
• Branch name
• Commit message

Since:

0.8.0

Author:

Sebastian Staudt

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	checkBranch	Check whether the current branch is the given branch
(package private) boolean	checkClean	Check if the working directory is clean
(package private) String	checkCommitMessage	Check whether the message of the current commit matches the given format
(package private) boolean	checkTag	Check whether the current commit is tagged
(package private) Pattern	commitMessagePattern

Fields inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

baseDir, dateFormat, dirtyFlag, dirtyIgnoreUntracked, failGracefully, gitDir, head, project, propertyPrefixes, skip, skipNoGit

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CheckMojo()

Method Summary

Modifier and Type	Method	Description
private void	checkBranch(GitRepository repository)	Checks if the branch matches the configured name
private void	checkClean(GitRepository repository)	Checks if the worktree is in a clean state
private void	checkCommitMessage(GitRepository repository)	Checks if commit message matches the configured pattern
private void	checkTag(GitRepository repository)	Checks if the the current HEAD is tagged
protected GitRepository	init()	Generic initialization for all Mavanagaiata mojos
(package private) void	initConfiguration()	Compiles the commit message check regex
protected void	run(GitRepository repository)	The actual implementation of the mojo

Methods inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

addProperty, execute, initRepository, prepareParameters

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

commitMessagePattern

Pattern commitMessagePattern

checkBranch

@Parameter(property="mavanagaiata.checkBranch")
String checkBranch

Check whether the current branch is the given branch

checkClean

@Parameter(property="mavanagaiata.checkClean",
           defaultValue="true")
boolean checkClean

Check if the working directory is clean

checkCommitMessage

@Parameter(property="mavanagaiata.checkCommitMessage")
String checkCommitMessage

Check whether the message of the current commit matches the given format

checkTag

@Parameter(property="mavanagaiata.checkTag",
           defaultValue="false")
boolean checkTag

Check whether the current commit is tagged

Constructor Detail

CheckMojo

public CheckMojo()

Method Detail

init

protected GitRepository init()
                      throws MavanagaiataMojoException

Description copied from class: AbstractGitMojo

Generic initialization for all Mavanagaiata mojos

This will initialize the JGit repository instance for further usage by the mojo.

Overrides:

init in class AbstractGitMojo

Returns:

false if the execution should be skipped

Throws:

MavanagaiataMojoException - if the repository cannot be initialized

initConfiguration

void initConfiguration()

Compiles the commit message check regex

run

protected void run(GitRepository repository)
            throws MavanagaiataMojoException

Description copied from class: AbstractGitMojo

The actual implementation of the mojo

Specified by:

run in class AbstractGitMojo

Parameters:

repository - The repository instance to use

Throws:

MavanagaiataMojoException - if there is an error during execution

checkBranch

private void checkBranch(GitRepository repository)
                  throws CheckMojoException,
                         GitRepositoryException

Checks if the branch matches the configured name

Parameters:

repository - The repository instance to check

Throws:

CheckMojoException - if the branch does not match

GitRepositoryException - if the current branch cannot be retrieved

See Also:

checkBranch

checkClean

private void checkClean(GitRepository repository)
                 throws CheckMojoException,
                        GitRepositoryException

Checks if the worktree is in a clean state

Parameters:

repository - The repository instance to check

Throws:

CheckMojoException - if the worktree is not clean

GitRepositoryException - if the worktree state cannot be retrieved

See Also:

checkClean

checkCommitMessage

private void checkCommitMessage(GitRepository repository)
                         throws GitRepositoryException,
                                CheckMojoException

Checks if commit message matches the configured pattern

Parameters:

repository - The repository instance to check

Throws:

CheckMojoException - if the commit message does not match

GitRepositoryException - if the current commit cannot be retrieved

See Also:

checkCommitMessage

checkTag

private void checkTag(GitRepository repository)
               throws GitRepositoryException,
                      CheckMojoException

Checks if the the current HEAD is tagged

Parameters:

repository - The repository instance to check

Throws:

CheckMojoException - if HEAD is not tagged

GitRepositoryException - if the commit cannot be described

See Also:

checkTag