Property Detail

• 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.

• 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

  The repository to perform the release on.

• boolean prefixTagNameWithV

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

• 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.

• java.lang.String remote

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

• 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

• GrgitReleasePluginExtension(Project project)

Method Detail

• java.lang.String getTagMessage()

  The message to use when tagging the release. Generated from generateTagMessage.

  Returns:

  message to use in release tag

• java.lang.String getTagName()

  Gets the tag name that will be used.

  Returns:

  the release tag name

• void setGrgit(Grgit grgit)

  Sets the repository to use on both this extension and the underlying version.

  Parameters:

  grgit - the repository to use

• void version(groovy.lang.Closure closure)

  Configure the version. Delegates to version.

  Parameters:

  closure - a closure to configure the version