GitVersion Class

Summary

GitVersion information
Namespace
Cake.Common.Tools.GitVersion
Base Types
  • object
graph BT Type-->Base0["object"] Type["GitVersion"] class Type type-node

Syntax

public sealed class GitVersion

Properties

Name Value Summary
AssemblySemFileVer string
Gets or sets the assembly semantic file version.
AssemblySemVer string
Gets or sets the assembly Semantic Version.
BranchName string
Gets or sets the branch name.
BuildMetaData string
Gets or sets the build metadata.
BuildMetaDataPadded string
Gets or sets the build metadata padded.
CommitDate string
Gets or sets the commit date
CommitsSinceVersionSource int?
Gets or sets the commits since version source
CommitsSinceVersionSourcePadded string
Gets or sets the commits since version source padded
FullBuildMetaData string
Gets or sets the major version.
FullSemVer string
Gets or sets the full Semantic Version.
InformationalVersion string
Gets or sets the informational version.
LegacySemVer string
Gets or sets the legacy Semantic Version.
LegacySemVerPadded string
Gets or sets the padded legacy Semantic Version.
Major int
Gets or sets the major version.
MajorMinorPatch string
Gets or sets the major, minor, and path.
Minor int
Gets or sets the minor version.
NuGetVersion string
Gets or sets the NuGet version.
NuGetVersionV2 string
Gets or sets the NuGet version for v2.
Patch int
Gets or sets the patch version.
PreReleaseLabel string
Gets or sets the pre-release label.
PreReleaseNumber int?
Gets or sets the pre-release number.
PreReleaseTag string
Gets or sets the pre-release tag.
PreReleaseTagWithDash string
Gets or sets the pre-release tag with dash.
SemVer string
Gets or sets the Semantic Version.
Sha string
Gets or sets the Git SHA.

Extension Methods

Name Value Summary
Dump<GitVersion>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GitVersion>(GitVersion[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GitVersion>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GitVersion>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GitVersion>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GitVersion>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin