Property Detail

• java.util.List<java.lang.String> branchEnv

  Fetch the branch from environment variable if available. By default, the environment is not taken into account, in order to be backward compatible with existing build systems.

• groovy.lang.Closure<java.lang.String> dirty

  Dirty mode. Closure that takes a version (display or full) and processes it to produce a dirty indicator. By default, it appends the dirtySuffix value to the version.

• boolean dirtyFailOnReleases

  If set to true, the build will fail if working copy is dirty and if the branch type is part of the releases list ("release" only by default).

• java.lang.String dirtySuffix

  Default dirty suffix

• java.lang.Object displayMode

  Display mode

• groovy.lang.Closure<java.lang.String> full

  Computes the full version.

• java.lang.String gitRepoRootDir

  Allow setting the root git repo directory for non conventional git/gradle setups. This is the path to the root directory that contains the .git folder. This is used to validate if the current project is a git repository.

• java.lang.String lastTagPattern

  Pattern used to match when looking for the last tag. By default, checks for any tag having a last part being numeric. At least one numeric grouping expression is required. The first one will be used to reverse order the tags in Git.

• boolean noWarningOnDirty

  If set to true, no warning will be printed in case the workspace is dirty.

• java.lang.String password

  Credentials (for SVN only)

• java.lang.Object releaseBuild

  True if it's release build. Default is true, and branch should be in releases-set.

• java.lang.Object releaseMode

  Release mode

• groovy.lang.Closure<ReleaseInfo> releaseParser

  Getting the version type from a branch. Default: getting the part before the first "/" (or a second optional 'separator' parameter). If no slash is found, takes the branch name as whole. For example: * release/2.0 --> release * feature/2.0 --> feature * master --> master

• java.util.Set<java.lang.String> releases

  Set of eligible branch types for computing a display version from the branch base name

• java.lang.String scm

  Version SCM - git by default

• java.lang.String snapshot

  Default Snapshot extension

• @java.lang.Deprecated boolean trustServerCert

  Certificate - accept SSL server certificates from unknown certificate authorities (for SVN only)

• java.lang.String user

  Credentials (for SVN only)

Constructor Detail

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

  Constructor

  Parameters:

  project - Linked project

Method Detail

• VersionInfo computeInfo()

  Computes the version information.

• VersionInfo getInfo()

  Gets the computed version information

• static java.lang.String normalise(java.lang.String value)