version-zio-prelude
DocsAPI
Generated with
version-zio-prelude/sbt Plugin/Settings

Settings

Configuration settings for the sbt plugin.

versionShaLength

SHA identifier truncation length.

versionShaLength := 12
Type Int
Range 7–40
Default 7

Example output: shaabc1234567890 vs shaabc1234

versionPrNumber

Pull request number for build metadata.

versionPrNumber := Some(42)

// From environment
versionPrNumber := sys.env.get("PR_NUMBER").flatMap(_.toIntOption)
Type Option[Int]
Default None

Adds pr42 to metadata when set.

versionBranchOverride

Override detected branch name.

versionBranchOverride := Some("release")
Type Option[String]
Default None (auto-detected)

Use when CI checkouts don't preserve branch information.

versionRead

The version.Version.Read[String] instance used for parsing version tags.

import version.Version

// Default: use standard SemVer parser
versionRead := Version.Read.ReadString

The version.PreRelease.Resolver is resolved contextually when version tags are parsed, not when the Read instance is created. Custom resolvers can be provided at the call site.
Type version.Version.Read[String]
Default version.Version.Read.ReadString

versionShow

The version.Version.Show instance for rendering.

import version.Version

// Include build metadata
versionShow := Some(Version.Show.Extended)

// Default: exclude metadata (None uses Standard internally)
versionShow := None
Type Option[version.Version.Show]
Default None

versionResolutionResult

Task returning the full resolution result.

val result = (versionResolutionResult).value

result.version // Version
result.isTagged // Boolean
result.isDirty // Boolean
result.baseTag // Option[String]
result.commitCount // Int
Type Task[ResolutionResult]

Example Configuration

// build.sbt

import version.Version

versionShaLength := 10
versionPrNumber := sys.env.get("GITHUB_PR_NUMBER").flatMap(_.toIntOption)
versionBranchOverride := sys.env.get("GITHUB_REF_NAME")
versionShow := Some(Version.Show.Extended)
Generated with