GitVersionOptions Class

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
NullableContextAttribute
NullableAttribute

Constructors

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.
ConfigurationMigrationInfo ConfigurationMigrationInfo
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

Extension Methods

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