MSBuildSettingsExtensions Class

Summary

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

Syntax

public static class MSBuildSettingsExtensions

Methods

Name Value Summary
AddFileLogger(MSBuildSettings) 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.
static
AddFileLogger(MSBuildSettings, MSBuildFileLogger) 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.
static
EnableBinaryLogger(MSBuildSettings) MSBuildSettings
Enables the binary logger with all the default settings.
static
EnableBinaryLogger(MSBuildSettings, MSBuildBinaryLogImports) MSBuildSettings
Enables the binary logger with the specified imports and default file name.
static
EnableBinaryLogger(MSBuildSettings, string) MSBuildSettings
Enables the binary logger with the specified log file name and no imports.
static
EnableBinaryLogger(MSBuildSettings, string, MSBuildBinaryLogImports) MSBuildSettings
Enables the binary logger with the specified log file name and imports.
static
SetAssemblyVersion(MSBuildSettings, string) MSBuildSettings
Sets the assembly version.
static
SetConfiguration(MSBuildSettings, string) MSBuildSettings
Sets the configuration.
static
SetContinuousIntegrationBuild(MSBuildSettings, bool?) MSBuildSettings
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
static
SetDetailedSummary(MSBuildSettings, bool) MSBuildSettings
Sets whether or not detailed summary should be enabled.
static
SetFileVersion(MSBuildSettings, string) MSBuildSettings
Sets the file version.
static
SetIncludeSymbols(MSBuildSettings, bool) MSBuildSettings
Sets whether or not a symbol package should be created.
static
SetInformationalVersion(MSBuildSettings, string) MSBuildSettings
Sets the informational version.
static
SetMaxCpuCount(MSBuildSettings, int?) MSBuildSettings
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
static
SetMSBuildPlatform(MSBuildSettings, MSBuildPlatform) MSBuildSettings
Sets the MSBuild platform.
static
SetNoConsoleLogger(MSBuildSettings, bool) MSBuildSettings
Sets whether or not no console logging should be enabled.
static
SetNodeReuse(MSBuildSettings, bool) MSBuildSettings
Sets whether or not node reuse should be enabled.
static
SetNoImplicitTarget(MSBuildSettings, bool) MSBuildSettings
Sets whether or not any targets should be passed to MSBuild.
static
SetNoLogo(MSBuildSettings, bool) MSBuildSettings
Sets whether or not copyright information at the start of the program should be shown.
static
SetPackageReleaseNotes(MSBuildSettings, string) MSBuildSettings
Sets the package release notes.
static
SetPackageVersion(MSBuildSettings, string) MSBuildSettings
Sets the package version.
static
SetPlatformTarget(MSBuildSettings, PlatformTarget) MSBuildSettings
Sets the platform target.
static
SetPlatformTarget(MSBuildSettings, string) MSBuildSettings
Sets the platform target.
static
SetRestoreLockedMode(MSBuildSettings, bool) 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.
static
SetSymbolPackageFormat(MSBuildSettings, string) MSBuildSettings
Sets the symbol package format.
static
SetVerbosity(MSBuildSettings, Verbosity) MSBuildSettings
Sets the build log verbosity.
static
SetVersion(MSBuildSettings, string) MSBuildSettings
Sets the version.
static
SetVersionPrefix(MSBuildSettings, string) MSBuildSettings
Sets the version prefix.
static
SetVersionSuffix(MSBuildSettings, string) MSBuildSettings
Sets the version suffix.
static
UseToolVersion(MSBuildSettings, MSBuildToolVersion) MSBuildSettings
Sets the tool version.
static
UseToolVersion(MSBuildSettings, string) MSBuildSettings
Sets the tool version.
static
WithConsoleLoggerParameter(MSBuildSettings, string) MSBuildSettings
Adds a console logger parameter.
static
WithLogger(MSBuildSettings, string, string, string) MSBuildSettings
Adds a custom logger.
static
WithProperty(MSBuildSettings, string, string[]) MSBuildSettings
Adds a property to the configuration.
static
WithRestore(MSBuildSettings) MSBuildSettings
Invoke the Restore target before any other target.
static
WithTarget(MSBuildSettings, string) MSBuildSettings
Adds a MSBuild target to the configuration.
static
WithWarningsAsError(MSBuildSettings, string[]) MSBuildSettings
Treat warnings as errors, if no codes specified all errors will be treated as errors.
static
WithWarningsAsMessage(MSBuildSettings, string[]) MSBuildSettings
Warnings to not treat as errors.
static

Extension Methods

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