DotNetMSBuildSettingsExtensions Class

Summary

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

Syntax

public static class DotNetMSBuildSettingsExtensions

Methods

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

Extension Methods

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