Version Variables

Version variables are quite useful if you need different formats of the version number. Running the gitversion executable in your repository will show you what is available. For the release/3.0.0 branch of GitVersion it shows: 

{
    "AssemblySemFileVer": "3.22.11.0",
    "AssemblySemVer": "3.22.11.0",
    "BranchName": "release/3.022.011",
    "BuildMetaData": 88,
    "CommitDate": "2021-12-31",
    "CommitsSinceVersionSource": 7,
    "EscapedBranchName": "release-3.022.011",
    "FullBuildMetaData": "99.Branch.release/3.22.11.Sha.28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
    "FullSemVer": "3.22.11-beta.99+88",
    "InformationalVersion": "3.22.11-beta.99+88.Branch.release/3.022.011.Sha.28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
    "Major": 3,
    "MajorMinorPatch": "3.22.11",
    "Minor": 22,
    "Patch": 11,
    "PreReleaseLabel": "beta",
    "PreReleaseLabelWithDash": "-beta",
    "PreReleaseNumber": 99,
    "PreReleaseTag": "beta.99",
    "PreReleaseTagWithDash": "-beta.99",
    "SemVer": "3.22.11-beta.99",
    "Sha": "28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
    "ShortSha": "28c8531",
    "UncommittedChanges": 0,
    "VersionSourceDistance": 7,
    "VersionSourceIncrement": "Minor",
    "VersionSourceSemVer": "3.22.11",
    "VersionSourceSha": "28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
    "WeightedPreReleaseNumber": 1099
}

Each property of the above JSON document is described in the below table.

Property Description
AssemblySemFileVer Suitable for .NET AssemblyFileVersion. Defaults to Major.Minor.Patch.0.
AssemblySemVer Suitable for .NET AssemblyVersion. Defaults to Major.Minor.0.0 to allow the assembly to be hotfixed without breaking existing applications that may be referencing it.
BranchName The name of the checked out Git branch.
BuildMetaData The build metadata, usually representing number of commits since the VersionSourceSha. Despite its name, will not increment for every build.
CommitDate The ISO-8601 formatted date of the commit identified by Sha.
CommitsSinceVersionSource (Deprecated: use VersionSourceDistance instead) The number of commits since the version source.
EscapedBranchName Equal to BranchName, but with / replaced with -.
FullBuildMetaData The BuildMetaData suffixed with BranchName and Sha.
FullSemVer The full, SemVer 2.0 compliant version number.
InformationalVersion Suitable for .NET AssemblyInformationalVersion. Defaults to FullSemVer suffixed by FullBuildMetaData.
Major The major version. Should be incremented on breaking changes.
MajorMinorPatch Major, Minor and Patch joined together, separated by ..
Minor The minor version. Should be incremented on new features.
Patch The patch version. Should be incremented on bug fixes.
PreReleaseLabel The pre-release label.
PreReleaseLabelWithDash The pre-release label prefixed with a dash.
PreReleaseNumber The pre-release number.
PreReleaseTag The pre-release tag is the pre-release label suffixed by the PreReleaseNumber.
PreReleaseTagWithDash The pre-release tag prefixed with a dash.
SemVer The semantical version number, including PreReleaseTagWithDash for pre-release version numbers.
Sha The SHA of the Git commit.
ShortSha The Sha limited to 7 characters.
UncommittedChanges The number of uncommitted changes present in the repository.
VersionSourceDistance The number of commits since the version source.
VersionSourceIncrement The increment strategy used for the version calculation. Possible values: None, Patch, Minor, Major.
VersionSourceSemVer The semantic version of the commit used as version source.
VersionSourceSha The SHA of the commit used as version source.
WeightedPreReleaseNumber A summation of branch specific pre-release-weight and the PreReleaseNumber. Can be used to obtain a monotonically increasing version number across the branches.

Depending on how and in which context GitVersion is executed (for instance within a supported build server), the above version variables may be exposed automatically as environment variables in the format GitVersion_FullSemVer.

Formatting Variables

GitVersion variables can be formatted using C# format strings. See Format Strings for details.

GitHub