ch.usi.si.seart.maven.plugin.git

Class GitSubmoduleUpdateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ch.usi.si.seart.maven.plugin.git.GitSubmoduleUpdateMojo

All Implemented Interfaces:

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

@Mojo(name="update",
      defaultPhase=INITIALIZE)
public class GitSubmoduleUpdateMojo
extends org.apache.maven.plugin.AbstractMojo

This goal is used to initialise and update all git submodules in a Maven project. It is a must when building for release. Typically, the maven-release-plugin will not include submodules when cloning the repository in the sandbox environment during release builds. With this plugin, the submodules will be updated at the beginning of the build process. As a result, one doesn't need to resort to writing custom scripts to update submodules.

Author:

Ozren Dabić

See Also:

Git Command Documentation

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GitSubmoduleUpdateMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
void	execute(org.eclipse.jgit.api.Git git) Perform the actual work of a plugin goal.
boolean	isVerbose()

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

Constructor Detail

GitSubmoduleUpdateMojo

public GitSubmoduleUpdateMojo()

Method Detail

execute

public void execute(org.eclipse.jgit.api.Git git)
             throws Exception

Perform the actual work of a plugin goal. Implementors overriding this method shouldn't concern themselves with closing the Git instance, as this is automatically performed once this method returns.

Parameters:

git - the git repository to work with.

Throws:

Exception - if an error occurs during execution.

isVerbose

public boolean isVerbose()

Returns:

true if the goal is executed in verbose mode, false otherwise.

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException