Package org.jenkinsci.gradle.plugins.jpi2

Class GitVersion

java.lang.Object

org.jenkinsci.gradle.plugins.jpi2.GitVersion

public final class GitVersion
extends Object

Computes a version string from the Git repository (commit depth + abbreviated hash).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GitVersion.VersionResult	Result of computing the Git-derived version (version string and full hash for file output).

Method Summary

Modifier and Type	Method	Description
static GitVersion.VersionResult	compute(Path gitRoot, String versionFormat, String versionPrefix, int abbrevLength, boolean allowDirty)	Computes the version string and full hash from the given Git repository and format options.

Methods inherited from class java.lang.Object

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

Method Details

compute

public static GitVersion.VersionResult compute(Path gitRoot,
 String versionFormat,
 String versionPrefix,
 int abbrevLength,
 boolean allowDirty)
                                        throws IOException,
InterruptedException

Computes the version string and full hash from the given Git repository and format options.

Parameters:

gitRoot - root of the Git repository

versionFormat - format string (e.g. "%d.%s" for depth.hash)

versionPrefix - prefix prepended to the formatted version

abbrevLength - length of the abbreviated hash

allowDirty - if false, throws when there are uncommitted changes

Returns:

version string and full hash

Throws:

IOException - if a git subprocess cannot be started or its output cannot be read

InterruptedException - if the thread is interrupted while waiting for git to finish