GitVersionVariables Class

Summary

Contains all version variables calculated by GitVersion for a given repository state.
Assembly
GitVersion.Core.dll
Namespace
GitVersion.OutputVariables
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IEnumerable<KeyValuePair<string, string>>"] Type-.->Interface1["IEnumerable"] Type-.->Interface2["IEquatable<GitVersionVariables>"] Type["GitVersionVariables"] class Type type-node

Syntax

public class GitVersionVariables : IEnumerable<KeyValuePair<string, string>>, IEnumerable, 
    IEquatable<GitVersionVariables>

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Properties

Name Value Summary
CommitCountSourceDistance string
Gets the count of non-ignored commits beyond the counting anchor.
CommitCountSourceSha string
Gets the commit used as the counting anchor, or null when counting all reachable history.
EqualityContract Type

Methods

Name Value Summary
Deconstruct(string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string) void
Equals(GitVersionVariables) bool
Equals(object) bool
get_AssemblySemFileVer() string
get_AssemblySemVer() string
get_BranchName() string
get_BuildMetaData() string
get_CommitDate() string
get_CustomVersion() string
get_EscapedBranchName() string
get_FullBuildMetaData() string
get_FullSemVer() string
get_InformationalVersion() string
get_Major() string
get_MajorMinorPatch() string
get_Minor() string
get_Patch() string
get_PreReleaseLabel() string
get_PreReleaseLabelName() string
get_PreReleaseLabelNameWithDash() string
get_PreReleaseLabelWithDash() string
get_PreReleaseNumber() string
get_SemVer() string
get_SemVerSourceIncrement() string
get_SemVerSourceSemVer() string
get_SemVerSourceSha() string
get_Sha() string
get_ShortSha() string
get_UncommittedChanges() string
get_VersionSourceDistance() string
get_VersionSourceIncrement() string
get_VersionSourceSemVer() string
get_VersionSourceSha() string
get_WeightedPreReleaseNumber() string
GetEnumerator() IEnumerator<KeyValuePair<string, string>>
Returns an enumerator that iterates over all version variable name/value pairs.
GetHashCode() int
PrintMembers(StringBuilder) bool
set_AssemblySemFileVer()
set_AssemblySemVer()
set_BranchName()
set_BuildMetaData()
set_CommitDate()
set_CustomVersion()
set_EscapedBranchName()
set_FullBuildMetaData()
set_FullSemVer()
set_InformationalVersion()
set_Major()
set_MajorMinorPatch()
set_Minor()
set_Patch()
set_PreReleaseLabel()
set_PreReleaseLabelName()
set_PreReleaseLabelNameWithDash()
set_PreReleaseLabelWithDash()
set_PreReleaseNumber()
set_SemVer()
set_SemVerSourceIncrement()
set_SemVerSourceSemVer()
set_SemVerSourceSha()
set_Sha()
set_ShortSha()
set_UncommittedChanges()
set_VersionSourceDistance()
set_VersionSourceIncrement()
set_VersionSourceSemVer()
set_VersionSourceSha()
set_WeightedPreReleaseNumber()
ToString() string
TryGetValue(string, string) bool
Attempts to retrieve the value of the version variable identified by variable.

Operators

Name Value Summary
operator !=(GitVersionVariables, GitVersionVariables) bool
operator ==(GitVersionVariables, GitVersionVariables) bool

Extension Methods

Name Value Summary
NotNull<GitVersionVariables>(string) T
Throws System.ArgumentNullException when value is null; otherwise returns the value.