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

Author:

Konrad 'ktoso' Malawski

Field Summary

Fields

Modifier and Type	Field and Description
static String	BRANCH
static String	BRANCH_CLASSIFIER
static String	BUILD_AUTHOR_EMAIL
static String	BUILD_AUTHOR_NAME
static String	BUILD_TIME
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_MESSAGE_FULL
static String	COMMIT_MESSAGE_SHORT
static String	COMMIT_TIME
static String	REMOTE_ORIGIN_URL

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
protected String	determineBranchName(org.eclipse.jgit.lib.Repository git, Map<String,String> env) If running within Jenkins/Hudosn, honor the branch name passed via GIT_BRANCH env var.
protected String	determineBranchNameOnBuildServer(org.eclipse.jgit.lib.Repository git, Map<String,String> env) Is "Jenkins aware", and prefers GIT_BRANCH to getting the branch via git if that enviroment variable is set.
void	execute()
Properties	getProperties()
void	setAbbrevLength(int abbrevLength)
void	setDateFormat(String dateFormat)
void	setDotGitDirectory(File dotGitDirectory)
void	setExcludeProperties(List<String> excludeProperties)
void	setFormat(String format)
void	setGitDescribe(GitDescribeConfig gitDescribe)
void	setPrefix(String prefix)
void	setVerbose(boolean verbose)
protected String	toBranchClassifier(String branch)

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

BRANCH_CLASSIFIER

public static final String BRANCH_CLASSIFIER

See Also:

Constant Field Values

COMMIT_ID

public static final String COMMIT_ID

See Also:

Constant Field Values

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

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

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

Constructor Detail

GitCommitIdMojo

public GitCommitIdMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

determineBranchName

protected String determineBranchName(org.eclipse.jgit.lib.Repository git,
                         Map<String,String> env)
                              throws IOException

If running within Jenkins/Hudosn, honor the branch name passed via GIT_BRANCH env var. This is necessary because Jenkins/Hudson alwways invoke build in a detached head state.

Parameters:

git -

env -

Returns:

results of git.getBranch() or, if in Jenkins/Hudson, value of GIT_BRANCH

Throws:

IOException

determineBranchNameOnBuildServer

protected String determineBranchNameOnBuildServer(org.eclipse.jgit.lib.Repository git,
                                      Map<String,String> env)
                                           throws IOException

Is "Jenkins aware", and prefers GIT_BRANCH to getting the branch via git if that enviroment variable is set. The variable is set by Jenkins/Hudson when put in detached HEAD state, but it still knows which branch was cloned.

Throws:

IOException

toBranchClassifier

protected String toBranchClassifier(String branch)

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)