Class GitVersionResult

Namespace

DotNetDo

Assembly

DotNetDo.Core.dll

The semantic version variables emitted by GitVersion.

public sealed record GitVersionResult : IEquatable<GitVersionResult>

Properties

AdditionalVariables

Additional variables emitted by newer or customized GitVersion versions.

[JsonExtensionData]
public Dictionary<string, JsonElement> AdditionalVariables { get; init; }

Property Value

Dictionary<string, JsonElement>

AssemblySemFileVer

The assembly file version.

public string? AssemblySemFileVer { get; init; }

Property Value

string?

AssemblySemVer

The assembly version.

public string? AssemblySemVer { get; init; }

Property Value

string?

BranchName

The checked-out branch name.

public string? BranchName { get; init; }

Property Value

string?

BuildMetaData

The build metadata, usually commits since the version source.

public int? BuildMetaData { get; init; }

Property Value

int?

CommitDate

The commit timestamp parsed from forced round-trip output.

public DateTimeOffset CommitDate { get; init; }

Property Value

DateTimeOffset

CommitsSinceVersionSource

The deprecated count of commits since the version source.

public int? CommitsSinceVersionSource { get; init; }

Property Value

int?

EscapedBranchName

The branch name with path separators replaced.

public string? EscapedBranchName { get; init; }

Property Value

string?

FullBuildMetaData

Build metadata including branch and commit identity.

public string? FullBuildMetaData { get; init; }

Property Value

string?

FullSemVer

The complete SemVer 2.0 version.

public string? FullSemVer { get; init; }

Property Value

string?

InformationalVersion

The assembly informational version.

public string? InformationalVersion { get; init; }

Property Value

string?

Major

The major version component.

public int Major { get; init; }

Property Value

int

MajorMinorPatch

The joined major, minor, and patch components.

public string? MajorMinorPatch { get; init; }

Property Value

string?

Minor

The minor version component.

public int Minor { get; init; }

Property Value

int

Patch

The patch version component.

public int Patch { get; init; }

Property Value

int

PreReleaseLabel

The prerelease label without punctuation.

public string? PreReleaseLabel { get; init; }

Property Value

string?

PreReleaseLabelWithDash

The prerelease label prefixed with a dash.

public string? PreReleaseLabelWithDash { get; init; }

Property Value

string?

PreReleaseNumber

The prerelease sequence number.

public int? PreReleaseNumber { get; init; }

Property Value

int?

PreReleaseTag

The prerelease label and sequence number.

public string? PreReleaseTag { get; init; }

Property Value

string?

PreReleaseTagWithDash

The prerelease tag prefixed with a dash.

public string? PreReleaseTagWithDash { get; init; }

Property Value

string?

SemVer

The semantic version excluding build metadata.

public string? SemVer { get; init; }

Property Value

string?

Sha

The complete commit SHA.

public string? Sha { get; init; }

Property Value

string?

ShortSha

The abbreviated commit SHA.

public string? ShortSha { get; init; }

Property Value

string?

UncommittedChanges

The number of uncommitted working-tree changes.

public int UncommittedChanges { get; init; }

Property Value

int

VersionSourceDistance

The number of commits since the version source.

public int VersionSourceDistance { get; init; }

Property Value

int

VersionSourceIncrement

The increment selected at the version source.

public string? VersionSourceIncrement { get; init; }

Property Value

string?

VersionSourceSemVer

The semantic version at the version source.

public string? VersionSourceSemVer { get; init; }

Property Value

string?

VersionSourceSha

The commit SHA of the version source.

public string? VersionSourceSha { get; init; }

Property Value

string?

WeightedPreReleaseNumber

The branch-weighted prerelease number.

public int? WeightedPreReleaseNumber { get; init; }

Property Value

int?