Summary
Represents a Git branch, exposing its tip commit and tracking information.
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
.Git - Interfaces
-
- IEquatable
<IBranch> - IComparable
<IBranch> - INamedReference
- ICommitish
- IEquatable
graph BT
Type-.->Interface0["IEquatable<IBranch>"]
Type-.->Interface1["IComparable<IBranch>"]
Type-.->Interface2["INamedReference"]
click Interface2 "/api/GitVersion.Git/INamedReference"
Type-.->Interface3["ICommitish"]
click Interface3 "/api/GitVersion.Git/ICommitish"
Type["IBranch"]
class Type type-node
Syntax
public interface IBranch : IEquatable<IBranch>, IComparable<IBranch>, INamedReference, ICommitish
Properties
| Name | Value | Summary |
|---|---|---|
| Commits | ICommitCollection |
Gets the ordered sequence of commits reachable from this branch's tip.
|
| IsDetachedHead | bool |
Gets a value indicating whether HEAD is in a detached state pointing at this branch's tip.
|
| IsRemote | bool |
Gets a value indicating whether this branch is a remote-tracking branch.
|
| IsTracking | bool |
Gets a value indicating whether this branch tracks a remote branch.
|
| Tip | ICommit |
Gets the most recent commit on this branch, or
null for an empty branch. |
Extension Methods
| Name | Value | Summary |
|---|---|---|
| NotNull |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|