Package com.github.koraktor.mavanagaiata.mojo

Class CheckMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
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 org.apache.maven.plugin.AbstractMojo
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
    protected String
    dateFormat
    The date format to use for various dates
    protected org.apache.maven.project.MavenProject
    project
    The Maven project

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

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    execute()
    Generic execution sequence for a Mavanagaiata mojo
    protected GitRepository
    init()
    Generic initialization for all Mavanagaiata mojos
    protected void
    run(GitRepository repository)
    The actual implementation of the mojo

    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 Details

    • dateFormat

      @Parameter(property="mavanagaiata.dateFormat", defaultValue="MM/dd/yyyy hh:mm a Z") protected String dateFormat
      The date format to use for various dates

    • project

      @Parameter(defaultValue="${project}", readonly=true) protected org.apache.maven.project.MavenProject project
      The Maven project

  • Constructor Details

    • CheckMojo

      public CheckMojo()

  • Method Details

    • init

      protected GitRepository init() throws com.github.koraktor.mavanagaiata.mojo.MavanagaiataMojoException
      Generic initialization for all Mavanagaiata mojos

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

      Returns:
      false if the execution should be skipped
      Throws:
      com.github.koraktor.mavanagaiata.mojo.MavanagaiataMojoException - if the repository cannot be initialized

    • run

      protected void run(GitRepository repository) throws com.github.koraktor.mavanagaiata.mojo.MavanagaiataMojoException
      The actual implementation of the mojo
      Parameters:
      repository - The repository instance to use
      Throws:
      com.github.koraktor.mavanagaiata.mojo.MavanagaiataMojoException - if there is an error during execution

    • execute

      public final void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Generic execution sequence for a Mavanagaiata mojo

      Will initialize any needed resources, run the actual mojo code and cleanup afterwards.

      Throws:
      org.apache.maven.plugin.MojoExecutionException - if the mojo execution fails and failGracefully is false
      org.apache.maven.plugin.MojoFailureException - if the mojo execution fails and failGracefully is true
      See Also: