TagStrategy (nebula-release-plugin 15.0.2 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

nebula.plugin.release.git.base.TagStrategy

Strategy for creating a Git tag associated with a release.

Properties Summary

Properties
Type	Name and description
`groovy.lang.Closure`	`generateMessage` Closure taking a ReleaseVersion as an argument and returning a string to be used as the tag's message.
`groovy.lang.Closure<com.github.zafarkhaja.semver.Version>`	`parseTag` Closure taking a org.ajoberstar.grgit.Tag as an argument and returning a com.github.zafarkhaja.semver.Version if the tag could be parsed, else '`null`'
`groovy.lang.Closure<java.lang.String>`	`toTagString` Closure taking a version String as an argument and returning a string to be used as a tag name.

Constructor Summary

Constructors
Constructor and description
`TagStrategy ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`maybeCreateTag(org.ajoberstar.grgit.Grgit grgit, ReleaseVersion version)` If the release version specifies a tag should be created, create a tag using the provided `Grgit` instance and this instance's state to determine the tag name and message.
	`void`	`setPrefixNameWithV(boolean prefix)` Added for backwards compatibility.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - groovy.lang.Closure generateMessage
    
    Closure taking a ReleaseVersion as an argument and returning a string to be used as the tag's message.
  - groovy.lang.Closure<com.github.zafarkhaja.semver.Version> parseTag
    
    Closure taking a org.ajoberstar.grgit.Tag as an argument and returning a com.github.zafarkhaja.semver.Version if the tag could be parsed, else 'null'
  - groovy.lang.Closure<java.lang.String> toTagString
    
    Closure taking a version String as an argument and returning a string to be used as a tag name.
- Constructor Detail
  - TagStrategy()
- Method Detail
  - java.lang.String maybeCreateTag(org.ajoberstar.grgit.Grgit grgit, ReleaseVersion version)
    
    If the release version specifies a tag should be created, create a tag using the provided Grgit instance and this instance's state to determine the tag name and message.
    Parameters:
    grgit - the repository to create the tag in
    version - the version to create the tag for
    Returns:
    the name of the tag created, or null if it wasn't
  - void setPrefixNameWithV(boolean prefix)
    
    Added for backwards compatibility.
    Parameters:
    prefix - whether or not to prefix the tag with a 'v'

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation