git-sensitive-semantic-versioning-gradle-plugin/org.danilopianini.gradle.gitsemver

Package-level declarations

Types

class GitSemVer @Inject constructor(providerFactory: ProviderFactory, objectFactory: ObjectFactory) : Plugin<Project>

A Plugin for comuting the project version based on the status of the local git repository.

open class GitSemVerExtension @JvmOverloads constructor(providerFactory: ProviderFactory, objectFactory: ObjectFactory, projectDir: File, version: String, logger: Logger, val minimumVersion: Property<String> = objectFactory.propertyWithDefault("0.1.0"), val developmentIdentifier: Property<String> = objectFactory.propertyWithDefault("dev"), val noTagIdentifier: Property<String> = objectFactory.propertyWithDefault("archeo"), val fullHash: Property<Boolean> = objectFactory.propertyWithDefault(false), val maxVersionLength: Property<Int> = objectFactory.propertyWithDefault(Int.MAX_VALUE), val developmentCounterLength: Property<Int> = objectFactory.propertyWithDefault(2), val enforceSemanticVersioning: Property<Boolean> = objectFactory.propertyWithDefault(true), val preReleaseSeparator: Property<String> = objectFactory.propertyWithDefault("-"), val buildMetadataSeparator: Property<String> = objectFactory.propertyWithDefault("+"), val distanceCounterRadix: Property<Int> = objectFactory.propertyWithDefault(DEFAULT_RADIX), val versionPrefix: Property<String> = objectFactory.propertyWithDefault(""), val includeLightweightTags: Property<Boolean> = objectFactory.propertyWithDefault(true), val forceVersionPropertyName: Property<String> = objectFactory.propertyWithDefault("forceVersion"), updateStrategy: (List<String>) -> UpdateType = { _ -> UpdateType.PATCH })

The plugin extension with the DSL.

PreReleaseIdentifier

data class PreReleaseIdentifier(val prefix: String = "-", segments: List<PreReleaseIdentifier.DotSeparatedIdentifier> = emptyList()) : Comparable<PreReleaseIdentifier>

A SemVer 2.0 pre-release identifier, with a selectable prefix.

SemanticVersion

data class SemanticVersion(val major: ULong, val minor: ULong, val patch: ULong, val preRelease: PreReleaseIdentifier = PreReleaseIdentifier.EMPTY, val buildMetadata: PreReleaseIdentifier = PreReleaseIdentifier.EMPTY) : Comparable<SemanticVersion>

A class representing semantic versions: major.minor.patch-preRelease+buildMetadata.

UpdateType

enum UpdateType : Enum<UpdateType>

The type of update that the commits represents. The following types are supported: