Property Detail

• boolean annotatedTagsOnly

  Use only annotated tags.

• boolean firstParentOnly

  Only visit the first parent, when searching for tags. See 'man git describe'

• boolean longFormat

  Always use the long format?

• java.lang.String match

  The match clause that is used to match the tags describing this projects version.

• groovy.lang.Closure postProcessVersion

  If you need to post-process the version yielded

• groovy.lang.Closure replaceGlobWith

  How to figure out the version from the matched tag. Default is to trim the prefix.

• MonotonouslyIncreasingVersionNumber versionNumber

  A scheme to define a monotonously increasing number from the versioning data.

• int versionNumberPadding

  How much padding should be used on the different places of the versionNumber. Use this when your version number CAN be a long instead of an int.

Constructor Detail

• VersioningExtension(org.gradle.api.Project project)

Method Detail

• static java.lang.String createRegexFromGlob(java.lang.String glob)

  Create a regex from a (simplified) glob pattern. Not currently used except in tests, but maybe we wanna use grgit in the future. So we might need it again to match the tags...

• java.lang.String describeLongVersion()

  Takes all options and calculates the long version with them, so longFormat is always set to true.

• java.lang.String describeVersion()

  Describe the version using git describe. You can add an optional 'match' glob, that will cause git describe to only match certain tags. By default, this is considered a prefix to the 'real' version number and is stripped away using GlobReplace.REPLACE_PREFIX. If this is not what you want, you can pass a closure, taking two arguments (glob, tag) to figure out how you want the version called. Example uses:
  describeVersion(), describeVersion(match: "database-*") For all options,

  See:

  DescribeVersionOptions

• boolean exactMatch()

  Returns true, if HEAD is currently pointing at a commit that has a tag (that matches the options of git describe).

• long versionNumber()

  Determine a monotonously increasing version number from the tags and number of commits.

  See:

  DefaultMonotonouslyIncreasingVersionNumber for details on how this is done by default. You can also override this by overwriting the property 'versionNumber'.

  Returns:

  a version number that is (should your tags be properly ordered) monotonously increasing.