Package com.github.koraktor.mavanagaiata.mojo

Klasse CheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

com.github.koraktor.mavanagaiata.mojo.CheckMojo

Alle implementierten Schnittstellen:

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

Seit:

0.8.0

Autor:

Sebastian Staudt

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
(Package privat) String	checkBranch	Check whether the current branch is the given branch
(Package privat) boolean	checkClean	Check if the working directory is clean
(Package privat) String	checkCommitMessage	Check whether the message of the current commit matches the given format
(Package privat) boolean	checkTag	Check whether the current commit is tagged
(Package privat) Pattern	commitMessagePattern

Von Klasse geerbte Felder com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

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

Von Schnittstelle geerbte Felder org.apache.maven.plugin.Mojo

ROLE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CheckMojo()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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 privat) void	initConfiguration()	Compiles the commit message check regex
protected void	run(GitRepository repository)	The actual implementation of the mojo

Von Klasse geerbte Methoden com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

addProperty, execute, initRepository, prepareParameters

Von Klasse geerbte Methoden org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

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

Konstruktordetails

CheckMojo

public CheckMojo()

Methodendetails

init

protected GitRepository init()
                      throws MavanagaiataMojoException

Beschreibung aus Klasse kopiert: AbstractGitMojo

Generic initialization for all Mavanagaiata mojos

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

Setzt außer Kraft:

init in Klasse AbstractGitMojo

Gibt zurück:

false if the execution should be skipped

Löst aus:

MavanagaiataMojoException - if the repository cannot be initialized

initConfiguration

void initConfiguration()

Compiles the commit message check regex

run

protected void run(GitRepository repository)
            throws MavanagaiataMojoException

Beschreibung aus Klasse kopiert: AbstractGitMojo

The actual implementation of the mojo

Angegeben von:

run in Klasse AbstractGitMojo

Parameter:

repository - The repository instance to use

Löst aus:

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

Parameter:

repository - The repository instance to check

Löst aus:

CheckMojoException - if the branch does not match

GitRepositoryException - if the current branch cannot be retrieved

Siehe auch:

• checkBranch

checkClean

private void checkClean(GitRepository repository)
                 throws CheckMojoException,
GitRepositoryException

Checks if the worktree is in a clean state

Parameter:

repository - The repository instance to check

Löst aus:

CheckMojoException - if the worktree is not clean

GitRepositoryException - if the worktree state cannot be retrieved

Siehe auch:

• checkClean

checkCommitMessage

private void checkCommitMessage(GitRepository repository)
                         throws GitRepositoryException,
CheckMojoException

Checks if commit message matches the configured pattern

Parameter:

repository - The repository instance to check

Löst aus:

CheckMojoException - if the commit message does not match

GitRepositoryException - if the current commit cannot be retrieved

Siehe auch:

• checkCommitMessage

checkTag

private void checkTag(GitRepository repository)
               throws GitRepositoryException,
CheckMojoException

Checks if the the current HEAD is tagged

Parameter:

repository - The repository instance to check

Löst aus:

CheckMojoException - if HEAD is not tagged

GitRepositoryException - if the commit cannot be described

Siehe auch:

• checkTag