GitVersionSettings Class

Summary

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

Syntax

public sealed class GitVersionSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
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.
ConfigFile FilePath
Gets or sets the path to config file.
Diag bool
Gets or sets a value indicating whether to run GitVersion with additional diagnostic information.
DynamicRepositoryPath DirectoryPath
Gets or sets the dynamic repository path. Defaults to %TEMP%.
EnsureAssemblyInfo bool
Gets or sets a value indicating whether if the assembly info file specified with /updateassemblyinfo or /updateassemblyinfofilename is not found, it be created with these attributes: AssemblyFileVersion, AssemblyVersion and AssemblyInformationalVersion.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
HandleExitCode Func<int, bool>
Gets or sets whether the exit code from the tool process causes an exception to be thrown.

If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code.

If the delegate returns true then no exception is thrown.

This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value.

Inherited from ToolSettings
LogFilePath FilePath
Gets or sets the path to the log file.
NoCache bool
Gets or sets a value indicating whether to bypass the cached GitVersion result. Result will not be written to the cache.
NoFetch bool
Gets or sets a value indicating whether to fetch repository information from remote when calculating version.
NoNormalize bool
Gets or sets a value indicating whether to disable normalize step on a build server.
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
Inherited from ToolSettings
OutputFile FilePath
Gets or sets the path to a file to store the asserted GitVersion numbers in JSON format.
OutputType GitVersionOutput?
Gets or sets the output type.
Password string
Gets or sets the password for the target repository.
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
RepositoryPath DirectoryPath
Gets or sets the path for the Git repository to use.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
ShowVariable string
Gets or sets whether to only show a specific variable.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
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.
UpdateProjectFiles bool
Gets or sets a value indicating whether to recursively search for all project files (.csproj/.vbproj/.fsproj) files in the git repo and update them.
UpdateWixVersionFile bool
Gets or sets a value indicating whether all the GitVersion variables are written to 'GitVersion_WixVersion.wxi'. The variables can then be referenced in other WiX project files for versioning.
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.
Verbosity GitVersionVerbosity?
Gets or sets the logging verbosity.
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.
Requires the Cake.Incubator addin
IsIn<GitVersionSettings>(GitVersionSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GitVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GitVersionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GitVersionSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GitVersionSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
WithArgumentCustomization<GitVersionSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<GitVersionSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<GitVersionSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<GitVersionSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<GitVersionSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<GitVersionSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<GitVersionSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<GitVersionSettings>(FilePath) T
Sets the tool path.
WithToolSettings<GitVersionSettings>(Action<GitVersionSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<GitVersionSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<GitVersionSettings>(DirectoryPath) T
Sets the tool working directory.