VersionerOptions (gradle-versioner 3.0.10 API)

Summary:
Property

| Detail:
Property

com.sarhanm.versioner.VersionerOptions

Extension closure to pass parameters from the build script to the plugin Example: build.gradle: versioner{ snapshot = true }
Authors:
mohammad sarhan

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`branchEnvName` Set to the environment Key that contains the branch name.
`groovy.lang.Closure<java.lang.String>`	`branchNameDisplayOverride` A closure that can return a custom value for the branch name displayed in the version string.
`java.lang.String`	`commonHotfixBranch` The branch name of the common hotfix branch.
`boolean`	`disableHotfixVersioning` This option is available because ios apps uploaded to the apple store require exactly 3 digit version numbers.
`boolean`	`disabled` Set to true to skip setting the version
`boolean`	`omitBranchMetadata` Set to true if you want to ommit all branch meta-data and only output digits.
`boolean`	`omitBranchMetadataOnSolidBranch` Set to true if you want to omit the branch meta-data and only output digits for solidBranches
`boolean`	`snapshot` Set to true to generate a snapshot version
`java.lang.String`	`solidBranchRegex` The regex used to match branch names which determines which branches get a non-zero major and minor versions

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
  - java.lang.String branchEnvName
    
    Set to the environment Key that contains the branch name. This is ONLY required for build systems other than jenkins and travis
  - groovy.lang.Closure<java.lang.String> branchNameDisplayOverride
    
    A closure that can return a custom value for the branch name displayed in the version string. The current Versioner instance will be passed as a parameter to the closure when called.
  - java.lang.String commonHotfixBranch
    
    The branch name of the common hotfix branch. Its the name of the branh that you fork from when you create a hotfix. Currently defaults to 'master'
  - boolean disableHotfixVersioning
    
    This option is available because ios apps uploaded to the apple store require exactly 3 digit version numbers. So having a 4th hotfix value will prevent successful submissions.
  - boolean disabled
    
    Set to true to skip setting the version
  - boolean omitBranchMetadata
    
    Set to true if you want to ommit all branch meta-data and only output digits.
  - boolean omitBranchMetadataOnSolidBranch
    
    Set to true if you want to omit the branch meta-data and only output digits for solidBranches
  - boolean snapshot
    
    Set to true to generate a snapshot version
  - java.lang.String solidBranchRegex
    
    The regex used to match branch names which determines which branches get a non-zero major and minor versions

Summary:
Property

| Detail:
Property

Groovy Documentation