Class VersionValueSource

java.lang.Object

io.github.joke.conventionalversion.VersionValueSource

All Implemented Interfaces:

org.gradle.api.provider.ValueSource<VersionResult, VersionValueSource.Parameters>

public abstract class VersionValueSource
extends Object
implements org.gradle.api.provider.ValueSource<VersionResult, VersionValueSource.Parameters>

Reads git and calculates the version, as a value source.

A ValueSource rather than a direct call during configuration: Gradle re-executes one on every build specifically to decide whether a cached entry is still valid. Reading git directly would bake the answer into the configuration cache entry, and the build would keep publishing a version derived from an older commit until something unrelated invalidated the entry.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VersionValueSource.Parameters	Everything that can change the answer, so that changing any of it re-runs the calculation.

Constructor Summary

Constructors

Constructor	Description
VersionValueSource()

Method Summary

Modifier and Type	Method	Description
@Nullable VersionResult	obtain()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.provider.ValueSource

getParameters

Constructor Details

VersionValueSource

public VersionValueSource()

Method Details

obtain

public @Nullable VersionResult obtain()

Specified by:

obtain in interface org.gradle.api.provider.ValueSource<VersionResult, VersionValueSource.Parameters>