Summary
Top-level options object that aggregates all settings used to configure a GitVersion execution.
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
- Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["GitVersionOptions"]
class Type type-node
Syntax
public class GitVersionOptions
Attributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
Constructors
| Name |
|---|
| GitVersionOptions |
Properties
| Name | Value | Summary |
|---|---|---|
| AssemblySettingsInfo | AssemblySettingsInfo |
Gets the assembly-update settings.
|
| AuthenticationInfo | AuthenticationInfo |
Gets the credentials used when authenticating with a remote repository.
|
| ConfigurationInfo | ConfigurationInfo |
Gets the settings that control how the GitVersion configuration file is located and applied.
|
| Configuration |
Configuration |
Gets the settings that control configuration migration.
|
| RepositoryInfo | RepositoryInfo |
Gets the repository-targeting settings (URL, branch, commit, clone path).
|
| Settings | Settings |
Gets the general runtime behaviour settings (cache, fetch, normalise).
|
| WixInfo | WixInfo |
Gets the WiX-specific version-file update settings.
|
| WorkingDirectory | string |
Gets or sets the working directory from which GitVersion should operate.
|
Methods
| Name | Value | Summary |
|---|---|---|
| get_Diag |
bool | |
| get_Format |
string | |
| get_IsHelp |
bool | |
| get_IsVersion |
bool | |
| get_LogFilePath |
string | |
| get_Output |
ISet |
|
| get_OutputFile |
string | |
| get_ShowVariable |
string | |
| set_Diag |
||
| set_Format |
||
| set_IsHelp |
||
| set_IsVersion |
||
| set_LogFilePath |
||
| set_Output |
||
| set_OutputFile |
||
| set_ShowVariable |
Extension Methods
| Name | Value | Summary |
|---|---|---|
| NotNull |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|