GitVersionExtension (gradleutils 2.6.6 API)

net.minecraftforge.gradleutils.gitversion.GitVersionExtension

```
@groovy.transform.CompileStatic
@java.lang.SuppressWarnings(value: GrDeprecatedAPIUsage)
class GitVersionExtension
extends java.lang.Object
```
The heart of the Git Version Gradle plugin. This extension is responsible for creating the GitVersion object and allowing access to it from Gradle buildscripts.
When using Gradle's Configuration Cache, the system Git config is disabled.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`NAME`

Properties Summary

Properties
Type	Name and description
`org.gradle.api.file.DirectoryProperty`	`gitDir`
`org.gradle.api.file.DirectoryProperty`	`projectDir`
`Property<java.lang.String>`	`projectPath`
`org.gradle.api.file.DirectoryProperty`	`rootDir`
`ListProperty<java.lang.String>`	`subprojectPaths`
`ListProperty<Directory>`	`subprojects`

Constructor Summary

Constructors
Constructor and description
`GitVersionExtension (org.gradle.api.Project project, org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.api.provider.ProviderFactory providers)` deprecated: This constructor will be made package-private in GradleUtils 3.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`net.minecraftforge.gitver.api.GitVersion$Info`	`getInfo()`
	`java.lang.String`	`getMCTagOffsetBranch(java.lang.String mcVersion)`
	`java.lang.String`	`getMCTagOffsetBranch(java.lang.String mcVersion, java.lang.String[] allowedBranches)`
	`java.lang.String`	`getMCTagOffsetBranch(java.lang.String mcVersion, java.util.Collection<java.lang.String> allowedBranches)`
	`Provider<java.lang.String>`	`getRelativePath(org.gradle.api.file.FileSystemLocation file)`
	`Provider<java.lang.String>`	`getRelativePath(Provider<? extends FileSystemLocation> file)`
	`ListProperty<java.lang.String>`	`getSubprojectPaths(boolean fromRoot)`
	`java.lang.String`	`getTagOffset()`
	`java.lang.String`	`getTagOffsetBranch()`
	`java.lang.String`	`getTagOffsetBranch(java.lang.String[] allowedBranches)`
	`java.lang.String`	`getTagOffsetBranch(java.util.Collection<java.lang.String> allowedBranches)`
	`java.lang.String`	`getUrl()`
	`net.minecraftforge.gitver.api.GitVersion`	`getVersion()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), 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()`

- Field Detail
  - public static final java.lang.String NAME
- Property Detail
  - @groovy.lang.Lazy org.gradle.api.file.DirectoryProperty gitDir
  - @groovy.lang.Lazy org.gradle.api.file.DirectoryProperty projectDir
  - @groovy.lang.Lazy Property<java.lang.String> projectPath
  - @groovy.lang.Lazy org.gradle.api.file.DirectoryProperty rootDir
  - @groovy.lang.Lazy ListProperty<java.lang.String> subprojectPaths
  - @groovy.lang.Lazy ListProperty<Directory> subprojects
- Constructor Detail
  - @javax.inject.Inject @java.lang.Deprecated(forRemoval: true) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) GitVersionExtension(org.gradle.api.Project project, org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.api.provider.ProviderFactory providers)
    
    deprecated:
    This constructor will be made package-private in GradleUtils 3.0
- Method Detail
  - net.minecraftforge.gitver.api.GitVersion$Info getInfo()
  - java.lang.String getMCTagOffsetBranch(java.lang.String mcVersion)
  - java.lang.String getMCTagOffsetBranch(java.lang.String mcVersion, java.lang.String[] allowedBranches)
  - java.lang.String getMCTagOffsetBranch(java.lang.String mcVersion, java.util.Collection<java.lang.String> allowedBranches)
  - Provider<java.lang.String> getRelativePath(org.gradle.api.file.FileSystemLocation file)
  - Provider<java.lang.String> getRelativePath(Provider<? extends FileSystemLocation> file)
  - ListProperty<java.lang.String> getSubprojectPaths(boolean fromRoot)
  - java.lang.String getTagOffset()
  - java.lang.String getTagOffsetBranch()
  - java.lang.String getTagOffsetBranch(java.lang.String[] allowedBranches)
  - java.lang.String getTagOffsetBranch(java.util.Collection<java.lang.String> allowedBranches)
  - @org.jetbrains.annotations.Nullable java.lang.String getUrl()
  - @java.lang.Deprecated(forRemoval: true) net.minecraftforge.gitver.api.GitVersion getVersion()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GitVersionExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String NAME

Property Detail

@groovy.lang.Lazy org.gradle.api.file.DirectoryProperty gitDir

@groovy.lang.Lazy org.gradle.api.file.DirectoryProperty projectDir

@groovy.lang.Lazy Property<java.lang.String> projectPath

@groovy.lang.Lazy org.gradle.api.file.DirectoryProperty rootDir

@groovy.lang.Lazy ListProperty<java.lang.String> subprojectPaths

@groovy.lang.Lazy ListProperty<Directory> subprojects

Constructor Detail

@javax.inject.Inject @java.lang.Deprecated(forRemoval: true) @ApiStatus.ScheduledForRemoval(inVersion: 3.0) GitVersionExtension(org.gradle.api.Project project, org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.api.provider.ProviderFactory providers)

Method Detail

net.minecraftforge.gitver.api.GitVersion$Info getInfo()

java.lang.String getMCTagOffsetBranch(java.lang.String mcVersion)

java.lang.String getMCTagOffsetBranch(java.lang.String mcVersion, java.lang.String[] allowedBranches)

java.lang.String getMCTagOffsetBranch(java.lang.String mcVersion, java.util.Collection<java.lang.String> allowedBranches)

Provider<java.lang.String> getRelativePath(org.gradle.api.file.FileSystemLocation file)

Provider<java.lang.String> getRelativePath(Provider<? extends FileSystemLocation> file)

ListProperty<java.lang.String> getSubprojectPaths(boolean fromRoot)

java.lang.String getTagOffset()

java.lang.String getTagOffsetBranch()

java.lang.String getTagOffsetBranch(java.lang.String[] allowedBranches)

java.lang.String getTagOffsetBranch(java.util.Collection<java.lang.String> allowedBranches)

@org.jetbrains.annotations.Nullable java.lang.String getUrl()

@java.lang.Deprecated(forRemoval: true) net.minecraftforge.gitver.api.GitVersion getVersion()