GrgitReleasePluginExtension (gradle-git 0.9.0 API)

Overview

Package

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD

DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.ajoberstar.gradle.git.release
[Groovy] Class GrgitReleasePluginExtension

java.lang.Object
  org.ajoberstar.gradle.git.release.GrgitReleasePluginExtension

class GrgitReleasePluginExtension

Extension providing properties to configure the behavior of the GrgitReleasePlugin.

Since:: 0.8.0

Property Summary
`boolean`	`enforceSinceTags` Runs task to check that all Since: tags in the source code point to a version that has been tagged in the repository, matches the inferred version (either the whole version or just the normal piece).
`groovy.lang.Closure`	`generateTagMessage` Closure to generate the message used when tagging releases.
`Grgit`	`grgit` The repository to perform the release on.
`boolean`	`prefixTagNameWithV` Whether or not to prefix release tag names with a "v".
`java.lang.Iterable`	`releaseTasks` Tasks that should be executed before the release is tagged, branched, and pushed to the remote.
`java.lang.String`	`remote` The remote to fetch from and push to.
`InferredVersion`	`version` The version class that will be set on the project by default.

Constructor Summary
`GrgitReleasePluginExtension(Project project)`

Method Summary
`java.lang.String`	`getTagMessage()` The message to use when tagging the release.
`java.lang.String`	`getTagName()` Gets the tag name that will be used.
`void`	`setGrgit(Grgit grgit)` Sets the repository to use on both this extension and the underlying version.
`void`	`version(groovy.lang.Closure closure)` Configure the version.

Methods inherited from 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

enforceSinceTags

boolean enforceSinceTags

Runs task to check that all

Since:: tags in the source code point to a version that has been tagged in the repository, matches the inferred version (either the whole version or just the normal piece). Defaults to false.

generateTagMessage

groovy.lang.Closure generateTagMessage

Closure to generate the message used when tagging releases. Is passed version after it is inferred. Should return a string. Defaults to "Release of ${version}".

grgit

Grgit grgit

The repository to perform the release on.

prefixTagNameWithV

boolean prefixTagNameWithV

Whether or not to prefix release tag names with a "v". Defaults to true.

releaseTasks

java.lang.Iterable releaseTasks

Tasks that should be executed before the release is tagged, branched, and pushed to the remote. Defaults to an empty list.

remote

java.lang.String remote

The remote to fetch from and push to. Defaults to origin.

version

InferredVersion version

The version class that will be set on the project by default. When the release is "readied" the intended version will be inferred from the state of the repository.

Constructor Detail