Index

A B C D E G H I L M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ALPHA - Enum constant in enum class com.cleanroommc.versioning.Stage

apply(Project) - Method in class com.cleanroommc.versioning.gradle.CleanroomVersioningPlugin

B

BETA - Enum constant in enum class com.cleanroommc.versioning.Stage

C

CleanroomVersioningPlugin - Class in com.cleanroommc.versioning.gradle

Sets project.version from Git tags, branch policy, and the build environment.

CleanroomVersioningPlugin() - Constructor for class com.cleanroommc.versioning.gradle.CleanroomVersioningPlugin

com.cleanroommc.versioning - package com.cleanroommc.versioning

com.cleanroommc.versioning.gradle - package com.cleanroommc.versioning.gradle

compareTo(SemanticVersion) - Method in record class com.cleanroommc.versioning.SemanticVersion

compute(GitState, String, Map<String, String>) - Static method in class com.cleanroommc.versioning.Versioning

Computes the version for the given state.

ComputedVersionValueSource - Class in com.cleanroommc.versioning.gradle

Turns a GitSnapshot and the build environment into the project version.

ComputedVersionValueSource() - Constructor for class com.cleanroommc.versioning.gradle.ComputedVersionValueSource

ComputedVersionValueSource.Parameters - Interface in com.cleanroommc.versioning.gradle

Inputs for the computed version.

D

dirty() - Method in record class com.cleanroommc.versioning.GitState

Returns the value of the dirty record component.

distance() - Method in record class com.cleanroommc.versioning.GitState

Returns the value of the distance record component.

E

equals(Object) - Method in record class com.cleanroommc.versioning.GitState

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.cleanroommc.versioning.SemanticVersion

Indicates whether some other object is "equal to" this one.

exactTag() - Method in record class com.cleanroommc.versioning.GitState

EXTENSION_NAME - Static variable in class com.cleanroommc.versioning.gradle.CleanroomVersioningPlugin

The name of the VersioningExtension.

G

getDevelopmentPrefix() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getDevelopmentPrefix() - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

The path prefix marking a development branch, develop by default.

getExecOperations() - Method in class com.cleanroommc.versioning.gradle.ComputedVersionValueSource

getExecOperations() - Method in class com.cleanroommc.versioning.gradle.GitSnapshotValueSource

getGithubActions() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getGithubHeadRef() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getGithubRefName() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getGithubRefType() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getGitSnapshot() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getLabel() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getLabel() - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

The pre-release label commits are counted under.

getMetadata() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getMetadata() - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

Additional pre-release identifiers, rendered as .<key>.<value> after the label in insertion order.

getReleaseBranch() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getReleaseBranch() - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

The branch a release tag has to be reachable from, master by default.

getRepositoryDirectory() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getRepositoryDirectory() - Method in interface com.cleanroommc.versioning.gradle.GitSnapshotValueSource.Parameters

getStage() - Method in interface com.cleanroommc.versioning.gradle.ComputedVersionValueSource.Parameters

getStage() - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

The release stage.

getVersion() - Method in class com.cleanroommc.versioning.gradle.PrintVersionTask

getVersion() - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

The version assigned to project.version.

GitSnapshotService - Class in com.cleanroommc.versioning.gradle

Holds one Git snapshot provider per repository, shared by every project that applies the plugin.

GitSnapshotService() - Constructor for class com.cleanroommc.versioning.gradle.GitSnapshotService

GitSnapshotValueSource - Class in com.cleanroommc.versioning.gradle

Reads the Git state the version is computed from.

GitSnapshotValueSource() - Constructor for class com.cleanroommc.versioning.gradle.GitSnapshotValueSource

GitSnapshotValueSource.Parameters - Interface in com.cleanroommc.versioning.gradle

Inputs for the snapshot.

GitState - Record Class in com.cleanroommc.versioning

Git inputs used to calculate a version.

GitState(SemanticVersion, SemanticVersion, long, boolean, boolean) - Constructor for record class com.cleanroommc.versioning.GitState

Creates an instance of a GitState record class.

H

hashCode() - Method in record class com.cleanroommc.versioning.GitState

Returns a hash code value for this object.

hashCode() - Method in record class com.cleanroommc.versioning.SemanticVersion

Returns a hash code value for this object.

I

id() - Method in enum class com.cleanroommc.versioning.Stage

INITIAL - Static variable in record class com.cleanroommc.versioning.SemanticVersion

The baseline used before the first tag exists.

isValid(String) - Static method in record class com.cleanroommc.versioning.SemanticVersion

L

latestTag() - Method in record class com.cleanroommc.versioning.GitState

Returns the value of the latestTag record component.

M

major() - Method in record class com.cleanroommc.versioning.SemanticVersion

Returns the value of the major record component.

minor() - Method in record class com.cleanroommc.versioning.SemanticVersion

Returns the value of the minor record component.

N

nextPatch() - Method in record class com.cleanroommc.versioning.SemanticVersion

O

obtain() - Method in class com.cleanroommc.versioning.gradle.ComputedVersionValueSource

obtain() - Method in class com.cleanroommc.versioning.gradle.GitSnapshotValueSource

P

parse(String) - Static method in record class com.cleanroommc.versioning.SemanticVersion

Parses a strict numeric version.

parse(String) - Static method in enum class com.cleanroommc.versioning.Stage

Parses a stage name, case insensitively.

parseTarget(String) - Static method in record class com.cleanroommc.versioning.SemanticVersion

Parses the version a development branch leads to.

patch() - Method in record class com.cleanroommc.versioning.SemanticVersion

Returns the value of the patch record component.

PLUGIN_ID - Static variable in class com.cleanroommc.versioning.gradle.CleanroomVersioningPlugin

The plugin identifier.

PRINT_VERSION_TASK - Static variable in class com.cleanroommc.versioning.gradle.CleanroomVersioningPlugin

The name of the task that prints the computed version.

printVersion() - Method in class com.cleanroommc.versioning.gradle.PrintVersionTask

PrintVersionTask - Class in com.cleanroommc.versioning.gradle

PrintVersionTask() - Constructor for class com.cleanroommc.versioning.gradle.PrintVersionTask

pushed() - Method in record class com.cleanroommc.versioning.GitState

Returns the value of the pushed record component.

R

RC - Enum constant in enum class com.cleanroommc.versioning.Stage

RELEASE - Enum constant in enum class com.cleanroommc.versioning.Stage

S

SemanticVersion - Record Class in com.cleanroommc.versioning

A strict numeric semantic version used by release tags.

SemanticVersion(long, long, long) - Constructor for record class com.cleanroommc.versioning.SemanticVersion

Creates an instance of a SemanticVersion record class.

setStage(Stage) - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

setStage(String) - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

Sets the stage from its name, case insensitively.

Stage - Enum Class in com.cleanroommc.versioning

Allowed release stages.

T

target() - Method in record class com.cleanroommc.versioning.GitState

Returns the value of the target record component.

toString() - Method in record class com.cleanroommc.versioning.GitState

Returns a string representation of this record class.

toString() - Method in class com.cleanroommc.versioning.gradle.VersioningExtension

toString() - Method in record class com.cleanroommc.versioning.SemanticVersion

Returns a string representation of this record class.

V

valueOf(String) - Static method in enum class com.cleanroommc.versioning.Stage

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.cleanroommc.versioning.Stage

Returns an array containing the constants of this enum class, in the order they are declared.

Versioning - Class in com.cleanroommc.versioning

Computes a tag-native project version from Git state and branch policy.

VersioningExtension - Class in com.cleanroommc.versioning.gradle

Configures the version label and exposes the computed version.

VersioningExtension(ObjectFactory) - Constructor for class com.cleanroommc.versioning.gradle.VersioningExtension

A B C D E G H I L M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form