Package net.videki.semver.cc.release.common

Class GitConventionalVersioning

java.lang.Object

net.videki.semver.cc.release.common.GitConventionalVersioning

All Implemented Interfaces:

ConventionalVersioning

public class GitConventionalVersioning
extends Object
implements ConventionalVersioning

Conventional commits version handler facade for a specific git repository. Use this for version resolution and handling of git repositories.

Constructor Summary

Constructors

Constructor	Description
GitConventionalVersioning(org.eclipse.jgit.lib.Repository repository)	Constructor to be used with a specific repo.

Method Summary

Modifier and Type	Method	Description
SemanticVersionChange	getNextVersionChangeType()	Calculates the change type ro calculate the next (release) version based on the commits since the last tag.
SemanticVersion	getReleaseVersion(SemanticVersion currentVersion)	Returns the actual release version based on the commits.
LogHandler	logHandler()	Returns the configured log handler for behaviourial logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitConventionalVersioning

public GitConventionalVersioning(org.eclipse.jgit.lib.Repository repository)

Constructor to be used with a specific repo.

Parameters:

repository - The repository to be parsed.

Method Detail

logHandler

public LogHandler logHandler()

Returns the configured log handler for behaviourial logging.

Specified by:

logHandler in interface ConventionalVersioning

Returns:

The log handler.

getNextVersionChangeType

public SemanticVersionChange getNextVersionChangeType()
                                               throws ScmApiException,
                                                      IOException

Calculates the change type ro calculate the next (release) version based on the commits since the last tag.

Specified by:

getNextVersionChangeType in interface ConventionalVersioning

Returns:

The top-most change type according to the commits.

Throws:

ScmApiException - thrown in case os SCM-related errors.

IOException - thrown in case of any IO issues.

getReleaseVersion

public SemanticVersion getReleaseVersion(SemanticVersion currentVersion)
                                  throws IOException,
                                         ScmApiException

Returns the actual release version based on the commits.

Specified by:

getReleaseVersion in interface ConventionalVersioning

Parameters:

currentVersion - The current (semantic) version.

Returns:

The release version (semantic version) to be passed over to the maven release plugin.

Throws:

IOException - thrown in case of any IO issues.

ScmApiException - thrown in case os SCM-related errors.