Summary
Contains settings used by
MSBuildRunner
.
- Namespace
- Cake
.Common .Tools .MSBuild - Base Types
-
- object
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
Type["MSBuildSettings"]
class Type type-node
Syntax
public sealed class MSBuildSettings : ToolSettings
Constructors
Name | Summary |
---|---|
MSBuildSettings |
Initializes a new instance of the MSBuildSettings class.
|
Properties
Name | Value | Summary |
---|---|---|
AllowPreviewVersion | bool |
Gets or sets a value indicating whether tools from a preview edition of Visual Studio should be used.
If set to |
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
|
AssemblyVersion | string |
Gets or sets the assembly version number embedded in the build output.
|
BinaryLogger | M |
Gets or sets the binary logging options.
|
Configuration | string |
Gets or sets the configuration.
|
Console |
ISet |
Gets the console logger parameters.
|
Continuous |
bool? |
Gets or sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
|
DetailedSummary | bool? |
Gets or sets whether or not detailed summary is created.
Shows detailed information at the end of the build
about the configurations built and how they were
scheduled to nodes.
|
EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
FileLoggers | ICollection |
Gets the file loggers.
|
FileVersion | string |
Gets or sets the file version number embedded in the build output.
|
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
|
IncludeSymbols | bool? |
Gets or sets a value indicating whether a symbol package should be created.
|
InformationalVersion | string |
Gets or sets the assembly informational version number embedded in the build output.
|
Loggers | ICollection |
Gets the loggers.
|
MaxCpuCount | int? |
Gets or sets the maximum CPU count.
If this value is zero, MSBuild will use as many processes as
there are available CPUs to build the project. If not set
MSBuild compile projects in this solution one at a time.
|
MSBuildPlatform | MSBuildPlatform |
Gets or sets the MSBuild platform.
|
NoConsoleLogger | bool? |
Gets or sets whether or not information is logged to the console.
Disable the default console logger and do not log events
to the console.
|
NodeReuse | bool? |
Gets or sets whether or not node reuse is used.
When you’re doing multiple builds in a row, this helps reduce your total build time,
by avoiding the start up costs of each MSBuild child node.
|
NoImplicitTarget | bool? |
Gets or sets a value indicating whether implicit target should be passed to MSBuild.
If set to true, no targets will be specified.
If set to false, and no targets specified, Build target will be passed by default.
|
NoLogo | bool? |
Gets or sets a value indicating whether to show copyright information at the start of the program.
|
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
|
PackageReleaseNotes | string |
Gets or sets the release notes of the NuGet package generated.
|
PackageVersion | string |
Gets or sets the version number of the NuGet package generated.
|
PlatformTarget | PlatformTarget? |
Gets or sets the platform target.
|
PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
Properties | IDictionary |
Gets the properties.
|
Restore | bool |
Gets or sets a value indicating whether the Restore target should be run before any other targets.
This setting will pass the /restore option down to MSBuild.
Use this setting when working with the new csproj format.
|
RestoreLockedMode | bool? |
Gets or sets a value indicating whether or not to lock the package dependency graph while
restoring, using the packages.lock.json file.
This setting is available with at least Visual Studio 2017 version 15.9 and above or NET SDK version 2.1.500 and above.
|
SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
SymbolPackageFormat | string |
Gets or sets the symbol package format.
|
Target | string |
Gets or sets the MSBuild target.
|
Targets | ISet |
Gets the targets.
|
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 | MSBuildToolVersion |
Gets or sets the tool version.
|
Verbosity | Verbosity |
Gets or sets the amount of information to display in the build log.
Each logger displays events based on the verbosity level that you set for that logger.
|
Version | string |
Gets or sets the default value of all the version numbers embedded in the build output.
|
VersionPrefix | string |
Gets or sets the base version number embedded in the build output.
|
VersionSuffix | string |
Gets or sets the pre-release label of the version number embedded in the build output.
|
WarningsAsError | bool |
Gets or sets a value indicating whether warnings should be treated as errors.
Treats all warnings as errors unless
WarningsAsErrorCodes has specific codes specified.
|
WarningsAsErrorCodes | ISet |
Gets the warning codes to treat as errors.
If any specified will implicitly be treated as true.
|
Warnings |
ISet |
Gets the warning codes to NOT treat as errors.
|
WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
Extension Methods
Name | Value | Summary |
---|---|---|
AddFileLogger |
MSBuildSettings |
Adds a file logger.
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
|
AddFileLogger |
MSBuildSettings |
Adds a file logger with all the default settings.
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
EnableBinaryLogger |
MSBuildSettings |
Enables the binary logger with the specified imports and default file name.
|
EnableBinaryLogger |
MSBuildSettings |
Enables the binary logger with the specified log file name and imports.
|
EnableBinaryLogger |
MSBuildSettings |
Enables the binary logger with the specified log file name and no imports.
|
EnableBinaryLogger |
MSBuildSettings |
Enables the binary logger with all the default settings.
|
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 |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
SetAssemblyVersion |
MSBuildSettings |
Sets the assembly version.
|
SetConfiguration |
MSBuildSettings |
Sets the configuration.
|
Set |
MSBuildSettings |
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
|
SetDetailedSummary |
MSBuildSettings |
Sets whether or not detailed summary should be enabled.
|
SetFileVersion |
MSBuildSettings |
Sets the file version.
|
SetIncludeSymbols |
MSBuildSettings |
Sets whether or not a symbol package should be created.
|
Set |
MSBuildSettings |
Sets the informational version.
|
SetMaxCpuCount |
MSBuildSettings |
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
|
SetMSBuildPlatform |
MSBuildSettings |
Sets the MSBuild platform.
|
SetNoConsoleLogger |
MSBuildSettings |
Sets whether or not no console logging should be enabled.
|
SetNodeReuse |
MSBuildSettings |
Sets whether or not node reuse should be enabled.
|
SetNoImplicitTarget |
MSBuildSettings |
Sets whether or not any targets should be passed to MSBuild.
|
SetNoLogo |
MSBuildSettings |
Sets whether or not copyright information at the start of the program should be shown.
|
Set |
MSBuildSettings |
Sets the package release notes.
|
SetPackageVersion |
MSBuildSettings |
Sets the package version.
|
SetPlatformTarget |
MSBuildSettings |
Sets the platform target.
|
SetPlatformTarget |
MSBuildSettings |
Sets the platform target.
|
SetRestoreLockedMode |
MSBuildSettings |
Sets whether or not to lock the package dependency graph while restoring, using the packages.lock.json file.
This setting is available with atleast Visual Studio 2017 version 15.9 and above or NET SDK version 2.1.500 and above.
|
Set |
MSBuildSettings |
Sets the symbol package format.
|
SetVerbosity |
MSBuildSettings |
Sets the build log verbosity.
|
SetVersion |
MSBuildSettings |
Sets the version.
|
SetVersionPrefix |
MSBuildSettings |
Sets the version prefix.
|
SetVersionSuffix |
MSBuildSettings |
Sets the version suffix.
|
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
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException 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
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|
UseToolVersion |
MSBuildSettings |
Sets the tool version.
|
UseToolVersion |
MSBuildSettings |
Sets the tool version.
|
With |
T |
Sets the tool argument customization delegate.
|
With |
MSBuildSettings |
Adds a console logger parameter.
|
With |
T |
Sets or adds tool environment variable.
|
WithExpectedExitCode |
T |
Sets expected exit code using
WithHandleExitCode<T>(T, Func<int, bool>) .
|
WithHandleExitCode |
T |
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
|
WithLogger |
MSBuildSettings |
Adds a custom logger.
|
With |
T |
Sets whether the tool should use a working directory or not.
|
WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
WithProperty |
MSBuildSettings |
Adds a property to the configuration.
|
WithRestore |
MSBuildSettings |
Invoke the Restore target before any other target.
|
With |
T |
Sets a delegate to configure the process settings.
|
WithTarget |
MSBuildSettings |
Adds a MSBuild target to the configuration.
|
WithToolPath |
T |
Sets the tool path.
|
WithToolSettings |
T |
Provides fluent null guarded tool settings action.
|
WithToolTimeout |
T |
Sets the tool timeout.
|
WithWarningsAsError |
MSBuildSettings |
Treat warnings as errors, if no codes specified all errors will be treated as errors.
|
With |
MSBuildSettings |
Warnings to not treat as errors.
|
WithWorkingDirectory |
T |
Sets the tool working directory.
|