GitCloneSettings Class

Summary

Contains settings used by GitClone.
Assembly
Cake.Git.dll
Namespace
Cake.Git
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GitCloneSettings"] class Type type-node

Syntax

public class GitCloneSettings

Constructors

Name Summary
GitCloneSettings()

Properties

Name Value Summary
BranchName string
The name of the branch to checkout. When unspecified the remote's default branch will be used instead.
Checkout bool
If true, the origin's HEAD will be checked out. This only applies to non-bare repositories.
IsBare bool
True will result in a bare clone, false a full clone.
RecurseSubmodules bool
Recursively clone submodules.

Extension Methods

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