Interface ConventionalVersioning
-
- All Known Implementing Classes:
GitConventionalVersioning
public interface ConventionalVersioningVersioning adapter.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SemanticVersionChangegetNextVersionChangeType()Main entry point to determine the next (post-release) development version.SemanticVersiongetReleaseVersion(SemanticVersion currentVersion)Main entry point to calculate the next release version based on the current version, the last SCM tag and commits since then.LogHandlerlogHandler()Internal log handler adapter for the calculation burndown.
-
-
-
Method Detail
-
logHandler
LogHandler logHandler()
Internal log handler adapter for the calculation burndown.- Returns:
- the confgiured log handler.
-
getNextVersionChangeType
SemanticVersionChange getNextVersionChangeType() throws ScmApiException, IOException
Main entry point to determine the next (post-release) development version.- Returns:
- The semantic version to be used after the next release.
- Throws:
ScmApiException- thrown in case of SCM-related errors.IOException- thrown in case of any IO-related issues.
-
getReleaseVersion
SemanticVersion getReleaseVersion(SemanticVersion currentVersion) throws IOException, ScmApiException
Main entry point to calculate the next release version based on the current version, the last SCM tag and commits since then.- Parameters:
currentVersion- The current (semantic) version.- Returns:
- The next (semantic) version based on the changes.
- Throws:
IOException- thrown in case of any IO issues.ScmApiException- thrown in case os SCM-related errors.
-
-