Groovy Documentation

org.ajoberstar.gradle.git.tasks
[Java] Class GitTag

java.lang.Object
  org.gradle.api.DefaultTask
      org.ajoberstar.gradle.git.tasks.GitBase
          org.ajoberstar.gradle.git.tasks.GitTag

public class GitTag
extends GitBase

Task to tag a commit in a Git repository.

Since:
0.2.0


Method Summary
boolean getForce()

Gets whether or not the tag will be created/updated even if a tag of that name already exists.

java.lang.String getMessage()

Gets the tag message to use.

boolean getSign()

Gets whether or not the tag will be signed with the tagger's default key.

java.lang.String getTagName()

Gets the tag name to use.

PersonIdent getTagger()

Gets the tagger.

void setForce(boolean force)

Sets whether or not the tag will be created/updated even if a tag of that name already exists.

void setMessage(java.lang.Object message)

Sets the tag message to use.

void setSign(boolean sign)

Sets whether or not the tag will be signed by the tagger's default key.

void setTagName(java.lang.Object tagName)

Sets the tag name to use.

void setTagger(PersonIdent tagger)

Sets the tagger.

void tag()

Tags the HEAD.

void tagger(groovy.lang.Closure config)

Configures the tagger.

 
Methods inherited from class GitBase
getGit, getRepoDir, setRepoPath
 

Method Detail

getForce

@Input
	public
public boolean getForce()
Gets whether or not the tag will be created/updated even if a tag of that name already exists. This defaults to false.
Returns:
true if the tag will be forced, false otherwise


getMessage

@Input
	@Option
al
	public
public java.lang.String getMessage()
Gets the tag message to use.
Returns:
the tag message to use


getSign

@Input
	public
public boolean getSign()
Gets whether or not the tag will be signed with the tagger's default key. This defaults to false.
Returns:
true if the tag will be signed, false otherwise


getTagName

@Input
	public
public java.lang.String getTagName()
Gets the tag name to use.
Returns:
the tag name to use


getTagger

@Input
	@Option
al
	public
public PersonIdent getTagger()
Gets the tagger.
Returns:
the tagger


setForce

public void setForce(boolean force)
Sets whether or not the tag will be created/updated even if a tag of that name already exists.
Parameters:
force - true if the tag will be forced, false otherwise


setMessage

public void setMessage(java.lang.Object message)
Sets the tag message to use.
Parameters:
message - the tag message


setSign

public void setSign(boolean sign)
Sets whether or not the tag will be signed by the tagger's default key.
Parameters:
sign - true if the tag should be signed, false otherwise


setTagName

public void setTagName(java.lang.Object tagName)
Sets the tag name to use.
Parameters:
tagName - the tag name


setTagger

public void setTagger(PersonIdent tagger)
Sets the tagger.
Parameters:
tagger - the tagger


tag

tion
	public
public void tag()
Tags the HEAD.


tagger

ssWarnings("rawtypes")
	public
public void tagger(groovy.lang.Closure config)
Configures the tagger. A PersonIdent is passed to the closure.
Parameters:
config - the configuration closure


 

Groovy Documentation