GitDescribeStrategy Class

Summary

Specify the kind of committish which will be considered when trying to identify the closest reference to the described commit.
Assembly
Cake.Git.dll
Namespace
Cake.Git
Base Types
  • Enum
graph BT Type-->Base0["Enum"] Type["GitDescribeStrategy"] class Type type-node

Syntax

public sealed class GitDescribeStrategy : Enum

Fields

Name Constant Value Summary
All 2
Instead of using only the annotated tags, use any ref found in refs/ namespace. This option enables matching any known branch, remote-tracking branch, or lightweight tag.
static
Default 0
Only annotated tags will be considered as reference points
static
Tags 1
Instead of using only the annotated tags, use any tag found in refs/tags namespace. This option enables matching a lightweight (non-annotated) tag.
static
value__

Extension Methods

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