GitVersionOptions Class

Summary

Top-level options object that aggregates all settings used to configure a GitVersion execution.
Namespace
GitVersion
Base Types
  • object
graph BT Type-->Base0["object"] Type["GitVersionOptions"] class Type type-node

Syntax

public class 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.
Diag bool
Gets or sets a value indicating whether extended diagnostic output should be emitted.
Format string
Gets or sets the output format string used when writing a single variable.
IsHelp bool
Gets or sets a value indicating whether help text should be printed and execution should stop.
IsVersion bool
Gets or sets a value indicating whether the GitVersion version number should be printed and execution should stop.
LogFilePath string
Gets or sets the path to a file where log output should be written.
Output ISet<OutputType>
Gets or sets the set of output types to produce (JSON, build-server, file, dotenv).
OutputFile string
Gets or sets the path of the file to which version output is written when the File output type is selected.
RepositoryInfo RepositoryInfo
Gets the repository-targeting settings (URL, branch, commit, clone path).
Settings Settings
Gets the general runtime behaviour settings (cache, fetch, normalise).
ShowVariable string
Gets or sets the name of a single version variable to output.
Verbosity Verbosity
Gets or sets the minimum log verbosity level.
WixInfo WixInfo
Gets the WiX-specific version-file update settings.
WorkingDirectory string
Gets or sets the working directory from which GitVersion should operate.

Extension Methods

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