fr.brouillard.oss.jgitver.impl

Class ScriptVersionStrategy

java.lang.Object

fr.brouillard.oss.jgitver.impl.VersionStrategy<ScriptVersionStrategy>

fr.brouillard.oss.jgitver.impl.ScriptVersionStrategy

public class ScriptVersionStrategy
extends VersionStrategy<ScriptVersionStrategy>

Executes the given script (according its ScriptType, default being ScriptType.GROOVY) and use the script output as version. This output must be in CSV format using ';' separator, with at least the 3 first columns, corresponding to integer values for major, minor and patch (e.g. 1;2;3). The script has access to metadata (e.g. In BeanShell for the SHA1 metadata.GIT_SHA1_8). The script also has access to the environment variables and system properties, respectively thanks to env (e.g. env.HOME) and sys (e.g. sys.user.home). If no script is passed as parameter then the default one is used, with the same behavior as the PATTERN strategy.

Nested Class Summary

Nested classes/interfaces inherited from class fr.brouillard.oss.jgitver.impl.VersionStrategy

VersionStrategy.StrategySearchMode

Constructor Summary

Constructors

Constructor and Description
ScriptVersionStrategy(VersionNamingConfiguration vnc, org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, MetadataRegistrar registrar) Default constructor.

Method Summary

Modifier and Type	Method and Description
Version	build(Commit head, List<Commit> parents) Build a version using the given information extracted from the git repository.
ScriptVersionStrategy	setScript(String script) Set the script to be interpreted.
ScriptVersionStrategy	setScriptType(ScriptType scriptType) Set the type of the script (default: ScriptType.GROOVY).

Methods inherited from class fr.brouillard.oss.jgitver.impl.VersionStrategy

computeTagType, enhanceVersionWithBranch, findMaxVersionCommit, findTagToUse, findVersionCommit, getBaseVersionAndRegisterMetadata, getGit, getRegistrar, getRepository, getVersionNamingConfiguration, isBaseCommitOnHead, isGitDirty, isVersionTag, maxVersionTag, maxVersionTag, runAndGetSelf, searchDepthLimit, searchMode, self, setSearchDepthLimit, tagToVersion, toVersionTarget, toVersionTarget, versionFromTag

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptVersionStrategy

public ScriptVersionStrategy(VersionNamingConfiguration vnc,
                             org.eclipse.jgit.lib.Repository repository,
                             org.eclipse.jgit.api.Git git,
                             MetadataRegistrar registrar)

Default constructor.

Parameters:

vnc - the configuration to use

repository - the git repository

git - a git helper object built from the repository

registrar - a storage for found/calculated metadata

Method Detail

build

public Version build(Commit head,
                     List<Commit> parents)
              throws VersionCalculationException

Description copied from class: VersionStrategy

Build a version using the given information extracted from the git repository.

Specified by:

build in class VersionStrategy<ScriptVersionStrategy>

Parameters:

head - cannot be null the current head commit

parents - a non null list of commits that will be involved in version naming. The list cannot be null and contains the first commit of the repository if no commit with version tag can be found.

Returns:

a non null Version object

Throws:

VersionCalculationException - in case an error occurred while computing the version

setScriptType

public ScriptVersionStrategy setScriptType(ScriptType scriptType)

Set the type of the script (default: ScriptType.GROOVY).

Parameters:

scriptType - the script type

Returns:

itself for chaining

setScript

public ScriptVersionStrategy setScript(String script)

Set the script to be interpreted.

Parameters:

script - the script content

Returns:

itself for chaining