The "semver-library"

This port of groovy-semver-tool written in Kotlin

License MIT

semver is a little tool to manipulate the version bumping in a project that follows the Semantic Versioning 2.0.0 .

Its use are:

• bump version
• extract specific version part
• compare versions

A version must match the following regular expression:

^[vV]?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(\-(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(\.(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$

In English:

The version must match X.Y.Z[-PRERELEASE][+BUILD] where X, Y and Z are non-negative integers. -PRERELEASE is a dot separated sequence of non-negative integers and/or identifiers composed of alphanumeric characters and hyphens (with at least one non-digit). Numeric identifiers must not have leading zeros. A hyphen ("-") introduces this optional part. -BUILD is a dot separated sequence of identifiers composed of alphanumeric characters and hyphens. A plus ("+") introduces this optional part.

Add Dependency

Maven

<dependency>
    <groupId>io.github.musk.semver</groupId>
    <artifactId>semver-library</artifactId>
    <version>1.3.0</version>
</dependency>

Gradle

Groovy DSL

implementation 'io.github.musk.semver:semver-library:1.3.0'
implementation group: 'io.github.github.musk.semver', name: 'semver-library', version: '1.3.0'

Kotlin DSL

implementation("io.github.musk.semver:semver-library:1.3.0")
implementation(group="io.github.musk.semver", name="semver-library", version="1.3.0")

Build

gradlew build publish

Release

gradlew build sign release publish -Prelease.signedTag=true -Prelease.sign=true -Psigning.secretKeyRingFile=<keyfile> -Psigning.keyId=2EDAFCEF -Psigning.user=mailtolanger@gmail.com -Psigning.password=<pwd> -Possrh.user=mailtolanger@gmail.com -Possrh.password=<pwd>

Examples

import com.github.musk.semver.Semver

// version validation
assert(!Semver.validate("1.2.invalid"))

// version change
val version = Semver.parse("1.2.3+abcd").prerel("rc1").minor()
assert(version.toString() == "1.3.0")
assert(version == Semver(1,3,0))

// version comparison v1 < v2
val v1 = Semver.parse("1.0.7+acf430")
val v2 = Semver(1,0,6).patch()
assert (v1 < v2)

See Java Demo for a demonstration of how to use the library in Java.
See Kotlin Demo for another demonstration of how to use the library in Kotlin. Also have a look at the 'release' task in this gradle build files for a practical usage scenario

Links

• Semantic Versioning 2.0.0
• Inspired by semver-tool written in bash.

Credits

• ported from groovy-semver-tool
• semver-tool project for the regex and the testcases