com.intershop.gradle.gitflow.utils

Class GitVersionService

com.intershop.gradle.gitflow.utils.GitVersionService

public class GitVersionService

Calculate the version from a Git Repository. The repository uses GitFlow for the development. The start parameter is the local source directory.

Field Detail

Companion

public static com.intershop.gradle.gitflow.utils.GitVersionService.Companion Companion

Constructor Detail

GitVersionService

@JvmOverloads
public GitVersionService(@NotNull
                                       java.io.File directory,
                                       @NotNull
                                       com.intershop.release.version.VersionType versionType)

creates the service from a directory

Parameters:

directory - local source directory

versionType - default value com.intershop.release.version.VersionType.fourDigits.

GitVersionService

@JvmOverloads
public GitVersionService(@NotNull
                                       java.io.File directory)

creates the service from a directory

Parameters:

directory - local source directory

Method Detail

getClient

@NotNull
public org.eclipse.jgit.api.Git getClient()

Git client for the existing working copy.

getRepository

@NotNull
public org.eclipse.jgit.lib.Repository getRepository()

Repository for the existing working copy.

getBranch

@NotNull
public java.lang.String getBranch()

This is the current branch name.

getMainBranch

@NotNull
public java.lang.String getMainBranch()

Name of the main branch. Default value is master.

setMainBranch

public void setMainBranch(@NotNull
                          java.lang.String p)

Name of the main branch. Default value is master.

getDevelopBranch

@NotNull
public java.lang.String getDevelopBranch()

Name of the develop branch. Default value is develop.

setDevelopBranch

public void setDevelopBranch(@NotNull
                             java.lang.String p)

Name of the develop branch. Default value is develop.

getHotfixPrefix

@NotNull
public java.lang.String getHotfixPrefix()

Prefix of a hotfix branch. Default value is hotfix.

setHotfixPrefix

public void setHotfixPrefix(@NotNull
                            java.lang.String p)

Prefix of a hotfix branch. Default value is hotfix.

getFeaturePrefix

@NotNull
public java.lang.String getFeaturePrefix()

Prefix of a feature branch. Default value is feature.

setFeaturePrefix

public void setFeaturePrefix(@NotNull
                             java.lang.String p)

Prefix of a feature branch. Default value is feature.

getReleasePrefix

@NotNull
public java.lang.String getReleasePrefix()

Prefix of a release branch. Default value is release.

setReleasePrefix

public void setReleasePrefix(@NotNull
                             java.lang.String p)

Prefix of a release branch. Default value is release.

getVersionPrefix

@NotNull
public java.lang.String getVersionPrefix()

Prefix of a version tag. Default value is version.

setVersionPrefix

public void setVersionPrefix(@NotNull
                             java.lang.String p)

Prefix of a version tag. Default value is version.

getSeparator

@NotNull
public java.lang.String getSeparator()

Separator for prefix and branch name. Default value is /.

setSeparator

public void setSeparator(@NotNull
                         java.lang.String p)

Separator for prefix and branch name. Default value is /.

getLocalOnly

public boolean getLocalOnly()

Version can be set for development to local only.

setLocalOnly

public void setLocalOnly(boolean p)

Version can be set for development to local only.

getDefaultVersion

@NotNull
public com.intershop.release.version.Version getDefaultVersion()

Default version. Default value is Version.Builder(versionType).build().

setDefaultVersion

public void setDefaultVersion(@NotNull
                              com.intershop.release.version.Version p)

Default version. Default value is Version.Builder(versionType).build().

getVersion

@NotNull
public java.lang.String getVersion()

This is the calculated version of the Git repository.

getRevID

@NotNull
public java.lang.String getRevID()

The revision id from the working copy (read only).

getPreviousVersion

@Nullable
public java.lang.String getPreviousVersion()

This is the calculated previous version from the Git repository.

getRevObjectFrom

@Nullable
public org.eclipse.jgit.revwalk.RevCommit getRevObjectFrom(@NotNull
                                                                     com.intershop.release.version.Version version)

Calculates the commit for a specified version.

Parameters:

version - is the a version