Summary
Controls general runtime behaviours such as caching, fetching, and branch normalisation.
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
- Interfaces
-
- IEquatable
<Settings>
- IEquatable
- Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type-.->Interface0["IEquatable<Settings>"]
Type["Settings"]
class Type type-node
Syntax
public class Settings : IEquatable<Settings>
Attributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
Constructors
Properties
| Name | Value | Summary |
|---|---|---|
| AllowShallow | bool |
Gets or sets a value indicating whether GitVersion should continue even when a shallow clone is detected.
|
| EqualityContract | Type | |
| NoCache | bool |
Gets or sets a value indicating whether the on-disk version cache should be ignored.
|
| NoFetch | bool |
Gets or sets a value indicating whether fetching from the remote should be skipped.
|
| NoNormalize | bool |
Gets or sets a value indicating whether branch normalisation should be skipped.
|
| OnlyTrackedBranches | bool |
Gets or sets a value indicating whether only tracked (remote-tracking) branches are considered during version calculation.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Equals |
bool | |
| Equals |
bool | |
| GetHashCode |
int | |
| PrintMembers |
bool | |
| ToString |
string |
Operators
| Name | Value | Summary |
|---|---|---|
| operator != |
bool | |
| operator == |
bool |
Extension Methods
| Name | Value | Summary |
|---|---|---|
| NotNull |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|