DotNetCorePublishSettings Class

Summary

Contains settings used by DotNetCorePublisher.
graph BT Type-->Base0["DotNetPublishSettings"] click Base0 "/api/Cake.Common.Tools.DotNet.Publish/DotNetPublishSettings" 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["DotNetCorePublishSettings"] class Type type-node

Syntax

public sealed class DotNetCorePublishSettings : DotNetPublishSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
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
Configuration string
Gets or sets the configuration under which to build.
Inherited from DotNetPublishSettings
DiagnosticOutput bool
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
EnableCompressionInSingleFile bool?
Gets or sets a value indicating whether to enable compression on the embedded assemblies when publishing a single-file executable.
Inherited from DotNetPublishSettings
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
Force bool
Gets or sets a value indicating whether to force all dependencies to be resolved even if the last restore was successful. This is equivalent to deleting project.assets.json.
Inherited from DotNetPublishSettings
Framework string
Gets or sets a specific framework to compile.
Inherited from DotNetPublishSettings
HandleExitCode Func<int, bool>
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
IncludeAllContentForSelfExtract bool?
Gets or sets a value indicating whether to bundle all content when publishing a platform-specific single-file executable. This will extract all files before running the executable and preserves the original .NET Core single-file deployment behavior.
Inherited from DotNetPublishSettings
IncludeNativeLibrariesForSelfExtract bool?
Gets or sets a value indicating whether to bundle native libraries when publishing a platform-specific single-file executable.
Inherited from DotNetPublishSettings
MSBuildSettings DotNetMSBuildSettings
Gets or sets additional arguments to be passed to MSBuild.
Inherited from DotNetPublishSettings
NoBuild bool
Gets or sets a value indicating whether to not to build the project before publishing. This makes build faster, but requires build to be done before publish is executed.
Inherited from DotNetPublishSettings
NoDependencies bool
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
Inherited from DotNetPublishSettings
NoLogo bool
Gets or sets a value indicating whether to display the startup banner or the copyright message.
Inherited from DotNetPublishSettings
NoRestore bool
Gets or sets a value indicating whether to not do implicit NuGet package restore. This makes build faster, but requires restore to be done before build is executed.
Inherited from DotNetPublishSettings
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
OutputDirectory DirectoryPath
Gets or sets the output directory.
Inherited from DotNetPublishSettings
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
PublishReadyToRun bool?
Gets or sets a value indicating whether to compile your application assemblies as ReadyToRun (R2R) format.
Inherited from DotNetPublishSettings
PublishReadyToRunShowWarnings bool?
Gets or sets a value indicating whether to show warnings emitted by ReadyToRun (R2R) compilation.
Inherited from DotNetPublishSettings
PublishSingleFile bool?
Gets or sets a value indicating whether to package your app into a platform-specific single-file executable.
Inherited from DotNetPublishSettings
PublishTrimmed bool?
Gets or sets a value indicating whether to reduce the size of apps by analyzing IL and trimming unused assemblies.
Inherited from DotNetPublishSettings
RollForward DotNetRollForward?
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
Runtime string
Gets or sets the target runtime.
Inherited from DotNetPublishSettings
SelfContained bool?
Gets or sets a value indicating whether Publish the .NET Core runtime with your application so the runtime doesn't need to be installed on the target machine. Defaults to 'true' if a runtime identifier is specified.
Inherited from DotNetPublishSettings
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
Sources ICollection<string>
Gets or sets the specified NuGet package sources to use during the restore.
Inherited from DotNetPublishSettings
TieredCompilation bool?
Gets or sets a value indicating whether tiered compilation is enabled.
Inherited from DotNetPublishSettings
TieredCompilationQuickJit bool?
Gets or sets a value as to whether tiered compilation quick JIT is enabled.
Inherited from DotNetPublishSettings
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbosity DotNetVerbosity?
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
VersionSuffix string
Gets or sets the value that defines what `*` should be replaced with in version field in project.json.
Inherited from DotNetPublishSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<DotNetCorePublishSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotNetCorePublishSettings>(DotNetCorePublishSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotNetCorePublishSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<DotNetCorePublishSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<DotNetCorePublishSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DotNetCorePublishSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin