Settings Class

Summary

Controls general runtime behaviours such as caching, fetching, and branch normalisation.
Assembly
GitVersion.Core.dll
Namespace
GitVersion
Interfaces
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
NullableContextAttribute
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

Operators

Name Value Summary
operator !=(Settings, Settings) bool
operator ==(Settings, Settings) bool

Extension Methods

Name Value Summary
NotNull<Settings>(string) T
Throws System.ArgumentNullException when value is null; otherwise returns the value.