GitLinkSettings Class

Summary

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

Syntax

public sealed class GitLinkSettings : 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 name of the branch to use on the remote repository.
Configuration string
Gets or sets the name of the configuration.
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
ErrorsAsWarnings bool
Gets or sets a value indicating whether the ErrorsAsWarnings option should be enabled.
IsDebug bool
Gets or sets a value indicating whether the debug output should be enabled.
LogFilePath FilePath
Gets or sets the path to the GitLink log file.
PdbDirectoryPath DirectoryPath
Gets or sets the directory where the PDB files are located.
Platform string
Gets or sets the name of the platform.
RepositoryUrl string
Gets or sets the Url to remote git repository.
ShaHash string
Gets or sets the SHA-1 hash of the git commit to be used.
SkipVerify bool
Gets or sets a value indicating whether the Skip Verify option should be enabled.
SolutionFileName string
Gets or sets the Solution file name.
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
UsePowerShell bool
Gets or sets a value indicating whether the Use PowerShell Command option should be enabled.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

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