GitVersionSettings Class

Summary

Contains settings used by GitVersionRunner.
Namespace
Cake.Common.Tools.GitVersion
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["GitVersionSettings"] class Type type-node

Syntax

public sealed class GitVersionSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<T, TResult>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
Branch string
Gets or sets the branch to use if using dynamic repositories.
Commit string
Gets or sets the branch to use if using dynamic repositories.
DynamicRepositoryPath DirectoryPath
Gets or sets the dynamic repository path. Defaults to %TEMP%.
EnvironmentVariables IDictionary<TKey, TValue>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
LogFilePath FilePath
Gets or sets the path to the log file.
NoFetch bool
Gets or sets a value indicating whether to fetch repository information from remote when calculating version.
OutputType Nullable<T>
Gets or sets the output type.
Password string
Gets or sets the password for the target repository.
RepositoryPath DirectoryPath
Gets or sets the path for the git repository to use.
ShowVariable string
Gets or sets whether to only show a specific variable.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout Nullable<T>
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
UpdateAssemblyInfo bool
Gets or sets a value indicating whether to update all the assemblyinfo files.
UpdateAssemblyInfoFilePath FilePath
Gets or sets whether to update all the assemblyinfo files.
Url string
Gets or sets the git url to use if using dynamic repositories.
UserName string
Gets or sets the username for the target repository.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<GitVersionSettings>() string
Get a basic string representation of specified object.
IsIn<GitVersionSettings>(GitVersionSettings[]) bool
Checks if the source is contained in a list
NotNull<GitVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
NotNull<GitVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
ThrowIfNull<GitVersionSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<GitVersionSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value