DotNetCoreMSBuildSettingsExtensions Class

Summary

Contains functionality related to .NET Core MSBuild settings.
Namespace
Cake.Common.Tools.DotNetCore.MSBuild
Base Types
  • object
graph BT Type-->Base0["object"] Type["DotNetCoreMSBuildSettingsExtensions"] class Type type-node

Syntax

public static class DotNetCoreMSBuildSettingsExtensions

Methods

Name Value Summary
AddFileLogger(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Adds a file logger with all the default settings.
static
AddFileLogger(DotNetCoreMSBuildSettings, MSBuildFileLoggerSettings) DotNetCoreMSBuildSettings
Adds a file logger.
static
DisableConsoleLogger(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Disables the default console logger, and not log events to the console.
static
EnableBinaryLogger(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Enables the binary logger with all the default settings.
static
EnableBinaryLogger(DotNetCoreMSBuildSettings, MSBuildBinaryLoggerImports) DotNetCoreMSBuildSettings
Enables the binary logger with the specified imports and default file name.
static
EnableBinaryLogger(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Enables the binary logger with the specified log file name and no imports.
static
EnableBinaryLogger(DotNetCoreMSBuildSettings, string, MSBuildBinaryLoggerImports) DotNetCoreMSBuildSettings
Enables the binary logger with the specified log file name and imports.
static
ExcludeAutoResponseFiles(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Exclude any MSBuild.rsp files automatically.
static
HideLogo(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Hide the startup banner and the copyright message.
static
SetConfiguration(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the configuration.
static
SetConsoleLoggerSettings(DotNetCoreMSBuildSettings, MSBuildLoggerSettings) DotNetCoreMSBuildSettings
Sets the parameters for the console logger.
static
SetFileVersion(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the file version.
static
SetInformationalVersion(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the informational version.
static
SetMaxCpuCount(DotNetCoreMSBuildSettings, int?) DotNetCoreMSBuildSettings
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
static
SetRuntime(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets a target operating systems where the application or assembly will run.
static
SetTargetFramework(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Adds a framework to target.
static
SetVersion(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the version.
static
SetVersionPrefix(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the version prefix.
static
SetVersionSuffix(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the version Suffix.
static
SetWarningCodeAsError(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the warning code to treats as an error.
static
SetWarningCodeAsMessage(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Sets the warning code to treats as a message.
static
ShowDetailedSummary(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Shows detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes.
static
SuppressVersionRecommendedFormatWarning(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
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).
static
TreatAllWarningsAs(DotNetCoreMSBuildSettings, MSBuildTreatAllWarningsAs) DotNetCoreMSBuildSettings
Sets how all warnings should be treated.
static
UseDistributedFileLogger(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Log the build output of each MSBuild node to its own file.
static
UseToolVersion(DotNetCoreMSBuildSettings, MSBuildVersion) DotNetCoreMSBuildSettings
Sets the version of the Toolset to use to build the project.
static
ValidateProjectFile(DotNetCoreMSBuildSettings) DotNetCoreMSBuildSettings
Validate the project file and, if validation succeeds, build the project.
static
WithDistributedLogger(DotNetCoreMSBuildSettings, MSBuildDistributedLogger) DotNetCoreMSBuildSettings
Adds a distributed loggers to use.
static
WithIgnoredProjectExtension(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Adds a extension to ignore when determining which project file to build.
static
WithLogger(DotNetCoreMSBuildSettings, string, string, string) DotNetCoreMSBuildSettings
Adds a custom logger.
static
WithProperty(DotNetCoreMSBuildSettings, string, string[]) DotNetCoreMSBuildSettings
Adds a property to the configuration.
static
WithResponseFile(DotNetCoreMSBuildSettings, FilePath) DotNetCoreMSBuildSettings
Adds a response file to use.
static
WithTarget(DotNetCoreMSBuildSettings, string) DotNetCoreMSBuildSettings
Adds a MSBuild target to the configuration.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin