RepositoryVersion Class

Summary

The version information for a git repository.
Assembly
Cake.RepoVersion.dll
Namespace
Cake.RepoVersion
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["RepositoryVersion"] class Type type-node

Syntax

public class RepositoryVersion

Constructors

Name Summary
RepositoryVersion()

Properties

Name Value Summary
Commits int
The number of commits in this version.
IsDirty bool
Indicates if the repository has local changes.
Label string
The pre-release label. This will be null or empty if the version is not a pre-release.
Major int
The major version.
Minor int
The minor version.
Patch int
The patch number.
SemVer string
The semantic version.

Extension Methods

Name Value Summary
Dump<RepositoryVersion>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<RepositoryVersion>(RepositoryVersion[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<RepositoryVersion>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<RepositoryVersion>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<RepositoryVersion>(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
ThrowIfNull<RepositoryVersion>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin