Summary
Contains settings used by
DotNetCoreMSBuildBuilder
.
- Namespace
- Cake
.Common .Tools .DotNetCore .MSBuild - Base Types
graph BT
Type-->Base0["DotNetMSBuildSettings"]
click Base0 "/api/Cake.Common.Tools.DotNet.MSBuild/DotNetMSBuildSettings"
Base0-->Base1["DotNetSettings"]
click Base1 "/api/Cake.Common.Tools.DotNet/DotNetSettings"
Base1-->Base2["ToolSettings"]
click Base2 "/api/Cake.Core.Tooling/ToolSettings"
Base2-->Base3["object"]
Type["DotNetCoreMSBuildSettings"]
class Type type-node
Syntax
public sealed class DotNetCoreMSBuildSettings : DotNetMSBuildSettings
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
|
AssemblyVersion | string |
Gets or sets the assembly version number embedded in the build output.
Inherited from Dot
|
BinaryLogger | M |
Gets or sets the binary logging options.
Inherited from Dot
|
Console |
M |
Gets or sets the parameters for the console logger.
Inherited from Dot
|
Continuous |
bool? |
Gets or sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
Inherited from Dot
|
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.
Inherited from Dot
|
DiagnosticOutput | bool |
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
|
DisableConsoleLogger | bool |
Gets or sets a value indicating whether to disable the default console logger, and not log events to the console.
Inherited from Dot
|
Distributed |
bool |
Gets or sets a value indicating whether to log the build output of each MSBuild node to its own file.
Inherited from Dot
|
DistributedLoggers | ICollection |
Gets the distributed loggers to use.
Inherited from Dot
|
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.
Inherited from Dot
|
FileLoggers | ICollection |
Gets the file loggers to use.
Inherited from Dot
|
FileVersion | string |
Gets or sets the file version number embedded in the build output.
Inherited from Dot
|
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.
Inherited from Dot
|
InformationalVersion | string |
Gets or sets the assembly informational version number embedded in the build output.
Inherited from Dot
|
Loggers | ICollection |
Gets the loggers to use to log events from MSBuild.
Inherited from Dot
|
MaxCpuCount | int? |
Gets or sets the maximum number of concurrent processes to use when building.
Inherited from Dot
|
NoLogo | bool |
Gets or sets a value indicating whether to display the startup banner and the copyright message.
Inherited from Dot
|
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.
Inherited from Dot
|
PackageVersion | string |
Gets or sets the version number of the NuGet package generated.
Inherited from Dot
|
PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
Properties | IDictionary |
Gets the project-level properties to set or override.
Inherited from Dot
|
ResponseFiles | ICollection |
Gets the response files to use.
Inherited from Dot
|
RollForward | DotNetRollForward? |
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
|
SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
Targets | ICollection |
Gets the targets to build in the project.
Inherited from Dot
|
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.
Inherited from Dot
|
TreatAllWarningsAs | M |
Gets or sets a value indicating how all warnings should be treated.
Inherited from Dot
|
ValidateProjectFile | bool |
Gets or sets a value indicating whether to validate the project file and, if validation succeeds, build the project.
Inherited from Dot
|
Verbosity | DotNetVerbosity? |
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
|
Version | string |
Gets or sets the default value of all the version numbers embedded in the build output.
Inherited from Dot
|
VersionPrefix | string |
Gets or sets the base version number embedded in the build output.
Inherited from Dot
|
VersionSuffix | string |
Gets or sets the pre-release label of the version number embedded in the build output.
Inherited from Dot
|
WarningCodesAsError | IList |
Gets the warning codes to treats as errors.
Inherited from Dot
|
Warning |
IList |
Gets the warning codes to treats as low importance messages.
Inherited from Dot
|
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.
|
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.
|
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.
|
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.
|
Exclude |
Dot |
Exclude any MSBuild.rsp files automatically.
|
HideLogo |
Dot |
Hide the startup banner and the copyright message.
|
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 IssuesArgumentChecks
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
SetAssemblyVersion |
Dot |
Sets the assembly version.
|
SetAssemblyVersion |
Dot |
Sets the assembly version.
|
SetConfiguration |
Dot |
Sets the configuration.
|
SetConfiguration |
Dot |
Sets the configuration.
|
Set |
Dot |
Sets the parameters for the console logger.
|
Set |
Dot |
Sets the parameters for the console logger.
|
Set |
Dot |
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
|
Set |
Dot |
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
|
SetFileVersion |
Dot |
Sets the file version.
|
SetFileVersion |
Dot |
Sets the file version.
|
Set |
Dot |
Sets the informational 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.
|
SetMaxCpuCount |
Dot |
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
|
Set |
Dot |
Sets the package release notes.
|
Set |
Dot |
Sets the package release notes.
|
SetPackageVersion |
Dot |
Sets the package version.
|
SetPackageVersion |
Dot |
Sets the package version.
|
SetRuntime |
Dot |
Sets a target operating systems where the application or assembly will run.
|
SetRuntime |
Dot |
Sets a target operating systems where the application or assembly will run.
|
SetTargetFramework |
Dot |
Adds a framework to target.
|
SetTargetFramework |
Dot |
Adds a framework to target.
|
SetVersion |
Dot |
Sets the version.
|
SetVersion |
Dot |
Sets the version.
|
SetVersionPrefix |
Dot |
Sets the version prefix.
|
SetVersionPrefix |
Dot |
Sets the version prefix.
|
SetVersionSuffix |
Dot |
Sets the version Suffix.
|
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 an error.
|
Set |
Dot |
Sets the warning code to treats as a message.
|
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.
|
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).
|
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.
|
TreatAllWarningsAs |
Dot |
Sets how all warnings should be treated.
|
Use |
Dot |
Log the build output of each MSBuild node to its own file.
|
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.
|
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.
|
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 distributed loggers to use.
|
With |
Dot |
Adds a extension to ignore when determining which project file to build.
|
With |
Dot |
Adds a extension to ignore when determining which project file to build.
|
WithLogger |
Dot |
Adds a custom logger.
|
WithLogger |
Dot |
Adds a custom logger.
|
WithProperty |
Dot |
Adds a property to the configuration.
|
WithProperty |
Dot |
Adds a property to the configuration.
|
WithResponseFile |
Dot |
Adds a response file to use.
|
WithResponseFile |
Dot |
Adds a response file to use.
|
WithTarget |
Dot |
Adds a MSBuild target to the configuration.
|
WithTarget |
Dot |
Adds a MSBuild target to the configuration.
|