GitBranch Class

Summary

Representation of a Git branch.
Assembly
Cake.Git.dll
Namespace
Cake.Git
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GitBranch"] class Type type-node

Syntax

public sealed class GitBranch

Constructors

Name Summary
GitBranch(Repository) Initializes a new instance of the GitBranch class.

Properties

Name Value Summary
CanonicalName string
Gets the full name of the branch.
FriendlyName string
Gets the human-friendly name of the branch.
IsRemote bool
Gets a value indicating whether this branch is remote.
RemoteName string
Gets the remote name for this branch.
Remotes List<GitRemote>
Gets or sets the remotes.
Tip GitCommit
Gets the commit this branch points to.

Methods

Name Value Summary
ToString() string
Generates a string representation of GitBranch

Extension Methods

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