semver/net.swiftzer.semver/SemVer

SemVer

@Serializable(with = SemVerSerializer::class)

data class SemVer(val major: Int, val minor: Int = 0, val patch: Int = 0, val preRelease: String? = null, val buildMetadata: String? = null) : Comparable<SemVer> (source)

Version number in Semantic Versioning 2.0.0 specification (SemVer).

Constructors

SemVer

constructor(major: Int, minor: Int = 0, patch: Int = 0, preRelease: String? = null, buildMetadata: String? = null)

Types

Companion

object Companion

Properties

buildMetadata

val buildMetadata: String? = null

build metadata.

major

val major: Int

major version, increment it when you make incompatible API changes.

minor

val minor: Int = 0

minor version, increment it when you add functionality in a backwards-compatible manner.

patch

val patch: Int = 0

patch version, increment it when you make backwards-compatible bug fixes.

preRelease

val preRelease: String? = null

pre-release version.

Functions

compareTo

open operator override fun compareTo(other: SemVer): Int

isInitialDevelopmentPhase

fun isInitialDevelopmentPhase(): Boolean

Check the version number is in initial development.

nextMajor

fun nextMajor(): SemVer

Create a new SemVer with the next major number. Minor and patch number becomes 0. Pre-release and build metadata information is not applied to the new version.

nextMinor

fun nextMinor(): SemVer

Create a new SemVer with the same major number and the next minor number. Patch number becomes 0. Pre-release and build metadata information is not applied to the new version.

nextPatch

fun nextPatch(): SemVer

Create a new SemVer with the same major and minor number and the next patch number. Pre-release and build metadata information is not applied to the new version.

toString

open override fun toString(): String

Build the version name string.