Getting Started

A Scala 3 toolkit for intent-based versioning conforming to Semantic Versioning 2.0.0.

Installation

Add the core library to your build:

libraryDependencies += "africa.shuwari" %% /* or `%%%` */ "version" % "@VERSION@"

Platform Support

Quick Example

import version.*
import version.given

// Parse a version string
val v = "1.2.3-alpha.1".toVersionUnsafe

// Inspect components
v.major.value // 1
v.minor.value // 2
v.patch.value // 3
v.preRelease.isDefined // true

// Bump versions
v.next[MajorVersion] // 2.0.0
v.next[MinorVersion] // 1.3.0
v.next[PatchNumber]  // 1.2.4

// Advance within same pre-release
v.next[Alpha]  // 1.2.3-alpha.2

// Work with pre-releases
v.core // 1.2.3
v.as[Snapshot] // 1.2.3-SNAPSHOT

What's Included

Objectives

Version numbers should encode intent, not build artefacts. This toolkit supports a declarative approach:

1. Commit messages express semantic intent — use directives like breaking:, feature:, or target: 2.0.0
2. Git tags mark releases — annotated tags define version boundaries
3. Build tools derive versions — the sbt plugin computes versions from Git state

This eliminates manual version bumping whilst preserving control over version semantics.

Next Steps

• Core Library — understand the version model
• Automatic Versioning — set up Git-based resolution
• sbt Plugin — integrate with your build

Licence

Licensed under the Apache License, Version 2.0.