DotNetSettings Class

Summary

Contains common settings used by DotNetTool<TSettings>.
graph BT Type-->Base0["ToolSettings"] click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base0-->Base1["object"] Type["DotNetSettings"] class Type type-node Derived0["DotNetNuGetDeleteSettings"]-->Type click Derived0 "/api/Cake.Common.Tools.DotNet.NuGet.Delete/DotNetNuGetDeleteSettings" Derived1["DotNetSDKCheckSettings"]-->Type click Derived1 "/api/Cake.Common.Tools.DotNet.SDKCheck/DotNetSDKCheckSettings" Derived2["DotNetPublishSettings"]-->Type click Derived2 "/api/Cake.Common.Tools.DotNet.Publish/DotNetPublishSettings" Derived3["DotNetRestoreSettings"]-->Type click Derived3 "/api/Cake.Common.Tools.DotNet.Restore/DotNetRestoreSettings" Derived4["DotNetNuGetPushSettings"]-->Type click Derived4 "/api/Cake.Common.Tools.DotNet.NuGet.Push/DotNetNuGetPushSettings" Derived5["DotNetBuildSettings"]-->Type click Derived5 "/api/Cake.Common.Tools.DotNet.Build/DotNetBuildSettings" Derived6["DotNetPackSettings"]-->Type click Derived6 "/api/Cake.Common.Tools.DotNet.Pack/DotNetPackSettings" Derived7["DotNetWorkloadSearchSettings"]-->Type click Derived7 "/api/Cake.Common.Tools.DotNet.Workload.Search/DotNetWorkloadSearchSettings" Derived8["DotNetCoreSettings"]-->Type click Derived8 "/api/Cake.Common.Tools.DotNetCore/DotNetCoreSettings" Derived9["DotNetToolSettings"]-->Type click Derived9 "/api/Cake.Common.Tools.DotNet.Tool/DotNetToolSettings" Derived10["DotNetBuildServerSettings"]-->Type click Derived10 "/api/Cake.Common.Tools.DotNet.BuildServer/DotNetBuildServerSettings" Derived11["DotNetCleanSettings"]-->Type click Derived11 "/api/Cake.Common.Tools.DotNet.Clean/DotNetCleanSettings" Derived12["DotNetVSTestSettings"]-->Type click Derived12 "/api/Cake.Common.Tools.DotNet.VSTest/DotNetVSTestSettings" Derived13["DotNetRunSettings"]-->Type click Derived13 "/api/Cake.Common.Tools.DotNet.Run/DotNetRunSettings" Derived14["DotNetMSBuildSettings"]-->Type click Derived14 "/api/Cake.Common.Tools.DotNet.MSBuild/DotNetMSBuildSettings" Derived15["DotNetNuGetSourceSettings"]-->Type click Derived15 "/api/Cake.Common.Tools.DotNet.NuGet.Source/DotNetNuGetSourceSettings" Derived16["DotNetTestSettings"]-->Type click Derived16 "/api/Cake.Common.Tools.DotNet.Test/DotNetTestSettings" Derived17["DotNetFormatSettings"]-->Type click Derived17 "/api/Cake.Common.Tools.DotNet.Format/DotNetFormatSettings" Derived18["DotNetExecuteSettings"]-->Type click Derived18 "/api/Cake.Common.Tools.DotNet.Execute/DotNetExecuteSettings"

Syntax

public abstract class DotNetSettings : 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
DiagnosticOutput bool
Gets or sets a value indicating whether to not enable diagnostic output.
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
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
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
RollForward DotNetRollForward?
Gets or sets the dotnet roll forward policy.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbosity DotNetVerbosity?
Gets or sets the verbosity of logging to use.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<DotNetSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotNetSettings>(DotNetSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotNetSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<DotNetSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<DotNetSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DotNetSettings>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin