org.unbrokendome.gradle.plugins.gitversion.tasks

Class DetermineGitVersion

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.unbrokendome.gradle.plugins.gitversion.tasks.DetermineGitVersion

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class DetermineGitVersion
extends org.gradle.api.internal.ConventionTask

A task that determines the version from a Git repository and stores it in a file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
DetermineGitVersion()

Method Summary

Modifier and Type	Method and Description
void	determineVersion() Determines the version and stores it in the target file.
SemVersion	getCachedVersion() Gets the version that was written to the target file by a previous invocation of this task.
java.io.File	getGitDirectory() Gets the full path of the .git directory of the Git repository that will be used for versioning.
java.lang.String	getOverrideBranchName() Gets the branch name that will be used for versioning.
java.io.File	getRepositoryLocation() Gets the location of the Git repository.
RulesContainer	getRules()
java.io.File	getTargetFile() Gets the target file to which the version will be written.
void	setOverrideBranchName(java.lang.String overrideBranchName) Sets the branch name that should be used for versioning.
void	setRepositoryLocation(java.io.File repositoryLocation) Sets the location of the Git repository that will be used for versioning.
void	setRules(RulesContainer rules)
void	setTargetFile(java.io.File targetFile) Sets the target file to which the version will be written.

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActionClassLoaders, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DetermineGitVersion

public DetermineGitVersion()

Method Detail

getRepositoryLocation

@Internal
public java.io.File getRepositoryLocation()

Gets the location of the Git repository.

Returns:

the full path to the repository

setRepositoryLocation

public void setRepositoryLocation(java.io.File repositoryLocation)

Sets the location of the Git repository that will be used for versioning.

The repository location may be either the work tree root, any subdirectory under it, or the .git directory. The location of the actual .git directory will then be determined from this path, and used as an input directory for the task.

Parameters:

repositoryLocation - the full path to the repository

getGitDirectory

@InputDirectory
 @Optional
 @Nullable
public java.io.File getGitDirectory()

Gets the full path of the .git directory of the Git repository that will be used for versioning.

Returns:

the full path of the .git directory

getRules

@Internal
 @Nullable
public RulesContainer getRules()

setRules

public void setRules(RulesContainer rules)

getOverrideBranchName

@Input
 @Optional
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(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

getTargetFile

@OutputFile
public java.io.File getTargetFile()

Gets the target file to which the version will be written.

Returns:

the full path to the target file

setTargetFile

public void setTargetFile(java.io.File targetFile)

Sets the target file to which the version will be written.

Parameters:

targetFile - the full path to the target file

getCachedVersion

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

Gets the version that was written to the target file by a previous invocation of this task.

Returns:

a SemVersion parsed from the contents of the version file that was previously written; null if the file does not exist

Throws:

java.io.IOException - for I/O errors

determineVersion

public void determineVersion()
                      throws java.io.IOException

Determines the version and stores it in the target file.

Throws:

java.io.IOException - for I/O errors