Summary
Contains settings used by
DotNetCoreMSBuildBuilder.
- Namespace
- Cake
.Common .Tools .DotNetCore .MSBuild - Base Types
-
- object
- ToolSettings
- DotNetCoreSettings
graph BT
Type-->Base0["DotNetCoreSettings"]
click Base0 "/api/Cake.Common.Tools.DotNetCore/DotNetCoreSettings"
Base0-->Base1["ToolSettings"]
click Base1 "/api/Cake.Core.Tooling/ToolSettings"
Base1-->Base2["object"]
Type["DotNetCoreMSBuildSettings"]
class Type type-node
Syntax
public sealed class DotNetCoreMSBuildSettings : DotNetCoreSettingsConstructors
| Name | Summary |
|---|---|
| Dot |
Initializes a new instance of the DotNetCoreMSBuildSettings class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| Argument |
Func |
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
|
| BinaryLogger | M |
Gets or sets the binary logging options.
|
| Console |
M |
Gets or sets the parameters for the console logger.
|
| DetailedSummary | bool |
Gets or sets a value indicating whether to show detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes.
|
| DiagnosticOutput | bool |
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetCoreSettings
|
| DisableConsoleLogger | bool |
Gets or sets a value indicating whether to disable the default console logger, and not log events to the console.
|
| Distributed |
bool |
Gets or sets a value indicating whether to log the build output of each MSBuild node to its own file.
|
| DistributedLoggers | ICollection |
Gets the distributed loggers to use.
|
| EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
| Exclude |
bool |
Gets or sets a value indicating whether to exclude any MSBuild.rsp files automatically.
|
| FileLoggers | ICollection |
Gets the file loggers to use.
|
| HandleExitCode | Func |
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
|
| Ignore |
ICollection |
Gets or sets extensions to ignore when determining which project file to build.
|
| Loggers | ICollection |
Gets the loggers to use to log events from MSBuild.
|
| MaxCpuCount | int? |
Gets or sets the maximum number of concurrent processes to use when building.
|
| NoLogo | bool |
Gets or sets a value indicating whether to display the startup banner and the copyright message.
|
| 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
|
| Properties | IDictionary |
Gets the project-level properties to set or override.
|
| ResponseFiles | ICollection |
Gets the response files to use.
|
| Targets | ICollection |
Gets the targets to build in the project.
|
| ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
| ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
| ToolVersion | MSBuildVersion? |
Gets or sets the version of the Toolset to use to build the project.
|
| TreatAllWarningsAs | M |
Gets or sets a value indicating how all warnings should be treated.
|
| ValidateProjectFile | bool |
Gets or sets a value indicating whether to validate the project file and, if validation succeeds, build the project.
|
| Verbosity | DotNetCoreVerbosity? |
Gets or sets the verbosity of logging to use.
Inherited from DotNetCoreSettings
|
| WarningCodesAsError | IList |
Gets the warning codes to treats as errors.
|
| Warning |
IList |
Gets the warning codes to treats as low importance messages.
|
| WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| AddFileLogger |
Dot |
Adds a file logger with all the default settings.
|
| AddFileLogger |
Dot |
Adds a file logger.
|
| DisableConsoleLogger |
Dot |
Disables the default console logger, and not log events to the console.
|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| EnableBinaryLogger |
Dot |
Enables the binary logger with all the default settings.
|
| EnableBinaryLogger |
Dot |
Enables the binary logger with the specified imports and default file name.
|
| EnableBinaryLogger |
Dot |
Enables the binary logger with the specified log file name and no imports.
|
| EnableBinaryLogger |
Dot |
Enables the binary logger with the specified log file name and imports.
|
| Exclude |
Dot |
Exclude any MSBuild.rsp files automatically.
|
| HideLogo |
Dot |
Hide the startup banner and the copyright message.
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| SetConfiguration |
Dot |
Sets the configuration.
|
| Set |
Dot |
Sets the parameters for the console logger.
|
| SetFileVersion |
Dot |
Sets the file version.
|
| Set |
Dot |
Sets the informational version.
|
| SetMaxCpuCount |
Dot |
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
|
| SetRuntime |
Dot |
Sets a target operating systems where the application or assembly will run.
|
| SetTargetFramework |
Dot |
Adds a framework to target.
|
| SetVersion |
Dot |
Sets the version.
|
| SetVersionPrefix |
Dot |
Sets the version prefix.
|
| SetVersionSuffix |
Dot |
Sets the version Suffix.
|
| Set |
Dot |
Sets the warning code to treats as an error.
|
| Set |
Dot |
Sets the warning code to treats as a message.
|
| ShowDetailedSummary |
Dot |
Shows detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes.
|
| Suppress |
Dot |
Suppress warning CS7035.
This is useful when using semantic versioning and either the file or informational version
doesn't match the recommended format.
The recommended format is: major.minor.build.revision where
each is an integer between 0 and 65534 (inclusive).
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| TreatAllWarningsAs |
Dot |
Sets how all warnings should be treated.
|
| Use |
Dot |
Log the build output of each MSBuild node to its own file.
|
| UseToolVersion |
Dot |
Sets the version of the Toolset to use to build the project.
|
| ValidateProjectFile |
Dot |
Validate the project file and, if validation succeeds, build the project.
|
| With |
Dot |
Adds a distributed loggers to use.
|
| With |
Dot |
Adds a extension to ignore when determining which project file to build.
|
| WithLogger |
Dot |
Adds a custom logger.
|
| WithProperty |
Dot |
Adds a property to the configuration.
|
| WithResponseFile |
Dot |
Adds a response file to use.
|
| WithTarget |
Dot |
Adds a MSBuild target to the configuration.
|