org.unbrokendome.gradle.plugins.gitversion

Class GitVersionExtension

java.lang.Object

org.unbrokendome.gradle.plugins.gitversion.GitVersionExtension

public class GitVersionExtension
extends java.lang.Object

DSL extension for the gitVersion block.

Constructor Summary

Constructors

Constructor and Description
GitVersionExtension(org.gradle.api.Project project, GitRepositoryFactory gitRepositoryFactory)

Method Summary

Modifier and Type	Method and Description
SemVersion	determineVersion()
SemVersion	getCachedVersion() Gets the version that was written to a file by an earlier invocation of a DetermineGitVersion task.
java.lang.Object	getLazyVersion() Returns a lazily-evaluated object that can be assigned to the Project.version property.
java.lang.String	getOverrideBranchName() Gets the branch name that will be used for versioning.
RulesContainer	getRules() Gets the container object that represents the versioning rules.
void	rules(org.gradle.api.Action<RulesContainer> action) Configures the rules using an action.
void	rules(groovy.lang.Closure closure) Configures the rules container using a closure.
void	setOverrideBranchName(java.lang.String overrideBranchName) Sets the branch name that should be used for versioning.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitVersionExtension

public GitVersionExtension(org.gradle.api.Project project,
                           GitRepositoryFactory gitRepositoryFactory)

Method Detail

getRules

@Nonnull
public RulesContainer getRules()

Gets the container object that represents the versioning rules.

Returns:

the RulesContainer

rules

public void rules(org.gradle.api.Action<RulesContainer> action)

Configures the rules using an action.

Parameters:

action - the configuration Action

rules

public void rules(@DelegatesTo(value=RulesContainer.class)
                  groovy.lang.Closure closure)

Configures the rules container using a closure.

Parameters:

closure - the configuration closure, executed in the context of the RulesContainer

determineVersion

@Nonnull
public SemVersion determineVersion()

getCachedVersion

@Nullable
public SemVersion getCachedVersion()
                                       throws java.io.IOException

Gets the version that was written to a file by an earlier invocation of a DetermineGitVersion task.

Returns:

the cached version, or null if the version file does not exist

Throws:

java.io.IOException - on I/O errors

getLazyVersion

@Nonnull
public java.lang.Object getLazyVersion()

Returns a lazily-evaluated object that can be assigned to the Project.version property. The version is only calculated the first time its toString() method is called.

If at the time of evaluation, the version cannot be determined, the toString() method will return an empty string.

Returns:

a lazily-evaluated version

getOverrideBranchName

@Nullable
public java.lang.String getOverrideBranchName()

Gets the branch name that will be used for versioning.

Returns:

the branch name, or null if the repository HEAD is used

setOverrideBranchName

public void setOverrideBranchName(@Nullable
                                  java.lang.String overrideBranchName)

Sets the branch name that should be used for versioning. This is intended for certain situations (like running on Jenkins CI) where it is necessary to pretend being on another branch than the repository actually is.

By default (if this property is null), the Git repository's HEAD branch is used.

Parameters:

overrideBranchName - the branch name, or null to use the repository HEAD