pl.project13.maven.git

Class GitCommitIdMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

pl.project13.maven.git.GitCommitIdMojo

All Implemented Interfaces:

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

public class GitCommitIdMojo
extends org.apache.maven.plugin.AbstractMojo

Goal which puts git build-time information into property files or maven's properties.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	BRANCH
static String	BUILD_AUTHOR_EMAIL
static String	BUILD_AUTHOR_NAME
static String	BUILD_HOST
static String	BUILD_TIME
static String	BUILD_VERSION
static String	CLOSEST_TAG_COMMIT_COUNT
static String	CLOSEST_TAG_NAME
static String	COMMIT_AUTHOR_EMAIL
static String	COMMIT_AUTHOR_NAME
static String	COMMIT_DESCRIBE
static String	COMMIT_ID
static String	COMMIT_ID_ABBREV
static String	COMMIT_ID_FLAT
static String	COMMIT_ID_FULL
static String	COMMIT_MESSAGE_FULL
static String	COMMIT_MESSAGE_SHORT
static String	COMMIT_SHORT_DESCRIBE
static String	COMMIT_TIME
static String	DIRTY
static String	REMOTE_ORIGIN_URL
protected org.apache.maven.execution.MavenSession	session The Maven Session Object
static String	TAGS

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GitCommitIdMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
LoggerBridge	getLoggerBridge()
Properties	getProperties()
void	setAbbrevLength(int abbrevLength)
void	setCommitIdGenerationMode(String commitIdGenerationMode)
void	setDateFormat(String dateFormat)
void	setDotGitDirectory(File dotGitDirectory)
void	setExcludeProperties(List<String> excludeProperties)
void	setFormat(String format)
void	setGitDescribe(GitDescribeConfig gitDescribe)
void	setIncludeOnlyProperties(List<String> includeOnlyProperties)
void	setPrefix(String prefix)
void	setVerbose(boolean verbose)
void	useNativeGit(boolean useNativeGit)

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

BRANCH

public static final String BRANCH

See Also:

Constant Field Values

DIRTY

public static final String DIRTY

See Also:

Constant Field Values

COMMIT_ID_FLAT

public static final String COMMIT_ID_FLAT

See Also:

Constant Field Values

COMMIT_ID_FULL

public static final String COMMIT_ID_FULL

See Also:

Constant Field Values

COMMIT_ID

public static String COMMIT_ID

COMMIT_ID_ABBREV

public static final String COMMIT_ID_ABBREV

See Also:

Constant Field Values

COMMIT_DESCRIBE

public static final String COMMIT_DESCRIBE

See Also:

Constant Field Values

COMMIT_SHORT_DESCRIBE

public static final String COMMIT_SHORT_DESCRIBE

See Also:

Constant Field Values

BUILD_AUTHOR_NAME

public static final String BUILD_AUTHOR_NAME

See Also:

Constant Field Values

BUILD_AUTHOR_EMAIL

public static final String BUILD_AUTHOR_EMAIL

See Also:

Constant Field Values

BUILD_TIME

public static final String BUILD_TIME

See Also:

Constant Field Values

BUILD_VERSION

public static final String BUILD_VERSION

See Also:

Constant Field Values

BUILD_HOST

public static final String BUILD_HOST

See Also:

Constant Field Values

COMMIT_AUTHOR_NAME

public static final String COMMIT_AUTHOR_NAME

See Also:

Constant Field Values

COMMIT_AUTHOR_EMAIL

public static final String COMMIT_AUTHOR_EMAIL

See Also:

Constant Field Values

COMMIT_MESSAGE_FULL

public static final String COMMIT_MESSAGE_FULL

See Also:

Constant Field Values

COMMIT_MESSAGE_SHORT

public static final String COMMIT_MESSAGE_SHORT

See Also:

Constant Field Values

COMMIT_TIME

public static final String COMMIT_TIME

See Also:

Constant Field Values

REMOTE_ORIGIN_URL

public static final String REMOTE_ORIGIN_URL

See Also:

Constant Field Values

TAGS

public static final String TAGS

See Also:

Constant Field Values

CLOSEST_TAG_NAME

public static final String CLOSEST_TAG_NAME

See Also:

Constant Field Values

CLOSEST_TAG_COMMIT_COUNT

public static final String CLOSEST_TAG_COMMIT_COUNT

See Also:

Constant Field Values

session

protected org.apache.maven.execution.MavenSession session

The Maven Session Object

Constructor Detail

GitCommitIdMojo

public GitCommitIdMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

setFormat

public void setFormat(String format)

setVerbose

public void setVerbose(boolean verbose)

setDotGitDirectory

public void setDotGitDirectory(File dotGitDirectory)

setPrefix

public void setPrefix(String prefix)

setDateFormat

public void setDateFormat(String dateFormat)

getProperties

public Properties getProperties()

setGitDescribe

public void setGitDescribe(GitDescribeConfig gitDescribe)

setAbbrevLength

public void setAbbrevLength(int abbrevLength)

setExcludeProperties

public void setExcludeProperties(List<String> excludeProperties)

setIncludeOnlyProperties

public void setIncludeOnlyProperties(List<String> includeOnlyProperties)

useNativeGit

public void useNativeGit(boolean useNativeGit)

setCommitIdGenerationMode

public void setCommitIdGenerationMode(String commitIdGenerationMode)

getLoggerBridge

public LoggerBridge getLoggerBridge()