fr.brouillard.oss.jgitver.impl

Class GitUtils

java.lang.Object

fr.brouillard.oss.jgitver.impl.GitUtils

public class GitUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
GitUtils()

Method Summary

Modifier and Type	Method and Description
static String	getTimestamp(java.time.Instant commitInstant) Builds a string representing the given instant interpolated in the current system timezone
static boolean	isAnnotated(org.eclipse.jgit.lib.Ref ref)
static boolean	isDetachedHead(org.eclipse.jgit.lib.Repository repository)
static boolean	isDirty(org.eclipse.jgit.api.Git git) Checks that underlying repository is dirty (modified with uncommitted changes).
static Optional<String>	providedBranchName() Provide the branch name externally provided in case we are building on a detached branch.
static String	sanitizeBranchName(String currentBranch)
static String	tagNameFromRef(org.eclipse.jgit.lib.Ref tag)

Methods inherited from class java.lang.Object

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

Constructor Detail

GitUtils

public GitUtils()

Method Detail

tagNameFromRef

public static String tagNameFromRef(org.eclipse.jgit.lib.Ref tag)

isAnnotated

public static boolean isAnnotated(org.eclipse.jgit.lib.Ref ref)

sanitizeBranchName

public static String sanitizeBranchName(String currentBranch)

isDetachedHead

public static boolean isDetachedHead(org.eclipse.jgit.lib.Repository repository)
                              throws IOException

Throws:

IOException

isDirty

public static boolean isDirty(org.eclipse.jgit.api.Git git)
                       throws org.eclipse.jgit.errors.NoWorkTreeException,
                              org.eclipse.jgit.api.errors.GitAPIException

Checks that underlying repository is dirty (modified with uncommitted changes).

Returns:

true if the underlying repository is dirty, false otherwise

Throws:

org.eclipse.jgit.api.errors.GitAPIException - if a git eeror occured while computing status

org.eclipse.jgit.errors.NoWorkTreeException - if the underlying repsoitory directory is not git managed

getTimestamp

public static String getTimestamp(java.time.Instant commitInstant)

Builds a string representing the given instant interpolated in the current system timezone

Parameters:

commitInstant - commit time as an Instant

Returns:

a string representing the commit time

providedBranchName

public static Optional<String> providedBranchName()

Provide the branch name externally provided in case we are building on a detached branch. It looks at:

• System property: `jgitver.branch`
• Environment variable: `JGITVER_BRANCH`

Returns:

the found branch name in the form of an optional.