Template Variables

Versionator uses Mustache templating. Use {{VariableName}} syntax in templates.

tip

Run versionator vars to see all variables with their current values.

Version Components

Core version numbers and formatting.

Variable	Description	Example
`{{Major}}`	Major version number	`1`
`{{Minor}}`	Minor version number	`2`
`{{Patch}}`	Patch version number	`3`
`{{MajorMinorPatch}}`	Core version: Major.Minor.Patch	`1.2.3`
`{{MajorMinor}}`	Major.Minor	`1.2`
`{{Prefix}}`	Version prefix	`v`

Pre-release identifier variables.

Variable	Description	Example
`{{PreRelease}}`	Rendered pre-release identifier	`alpha-5`
`{{PreReleaseWithDash}}`	Pre-release with leading dash	`-alpha-5`
`{{PreReleaseLabel}}`	Label part of pre-release	`alpha`
`{{PreReleaseNumber}}`	Number part of pre-release	`5`

Build metadata variables.

Variable	Description	Example
`{{Metadata}}`	Rendered build metadata	`20241211.abc1234`
`{{MetadataWithPlus}}`	Metadata with leading plus	`+20241211.abc1234`

Version control information.

Variable	Description	Example
`{{Hash}}`	Full commit hash (40 chars)	`abc1234def5678...`
`{{ShortHash}}`	Short commit hash (7 chars)	`abc1234`
`{{MediumHash}}`	Medium commit hash (12 chars)	`abc1234def01`
`{{BranchName}}`	Current branch name	`feature/foo`
`{{EscapedBranchName}}`	Branch with slashes replaced	`feature-foo`
`{{CommitsSinceTag}}`	Commits since last tag	`42`
`{{BuildNumber}}`	Alias for CommitsSinceTag	`42`
`{{BuildNumberPadded}}`	Padded to 4 digits	`0042`
`{{UncommittedChanges}}`	Count of uncommitted files	`3`
`{{Dirty}}`	'dirty' if uncommitted changes exist	`dirty`
`{{VersionSourceHash}}`	Hash of commit that last tag points to	`def5678`

Details about the current commit.

Timestamps at build time.