This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Git.

Summary

Representation of a Git branch.

Assembly

Cake.Git.dll

Namespace

Cake.Git

Base Types

graph BT Type-->Base0["Object"] Type["GitBranch"] class Type type-node

Syntax

public sealed class GitBranch

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

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.

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

Name	Value	Summary
Dump<GitBranch>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<GitBranch>(GitBranch[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<GitBranch>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<GitBranch>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<GitBranch>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<GitBranch>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin