Summary
Contains settings used by
DotNetPublisher.
- Namespace
- Cake
.Common .Tools .DotNet .Publish - Base Types
-
- object
- ToolSettings
- DotNetSettings
graph BT
Type-->Base0["DotNetSettings"]
click Base0 "/api/Cake.Common.Tools.DotNet/DotNetSettings"
Base0-->Base1["ToolSettings"]
click Base1 "/api/Cake.Core.Tooling/ToolSettings"
Base1-->Base2["object"]
Type["DotNetPublishSettings"]
class Type type-node
Syntax
public class DotNetPublishSettings : DotNetSettingsProperties
| 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
|
| Configuration | string |
Gets or sets the configuration under which to build.
|
| DiagnosticOutput | bool |
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
|
| Enable |
bool? |
Gets or sets a value indicating whether to enable compression on the embedded assemblies when publishing a single-file executable.
|
| EnvironmentVariables | IDictionary |
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.
|
| Framework | string |
Gets or sets a specific framework to compile.
|
| 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
|
| Include |
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.
|
| Include |
bool? |
Gets or sets a value indicating whether to bundle native libraries when publishing a platform-specific single-file executable.
|
| MSBuildSettings | Dot |
Gets or sets additional arguments to be passed to MSBuild.
|
| 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.
|
| NoDependencies | bool |
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
|
| NoLogo | bool |
Gets or sets a value indicating whether to display the startup banner or the copyright message.
|
| 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.
|
| 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
|
| OS | string |
Gets or sets the target operating system (OS).
This is a shorthand syntax for setting the Runtime Identifier (RID), where the provided value is combined with the default RID.
If you use this option, don't use the -r|--runtime option.
|
| OutputDirectory | DirectoryPath |
Gets or sets the output directory.
|
| PostAction | Action |
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.
|
| Publish |
bool? |
Gets or sets a value indicating whether to show warnings emitted by ReadyToRun (R2R) compilation.
|
| PublishSingleFile | bool? |
Gets or sets a value indicating whether to package your app into a platform-specific single-file executable.
|
| PublishTrimmed | bool? |
Gets or sets a value indicating whether to reduce the size of apps by analyzing IL and trimming unused assemblies.
|
| RollForward | DotNetRollForward? |
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
|
| Runtime | string |
Gets or sets the target runtime.
|
| 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.
|
| SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
| Sources | ICollection |
Gets or sets the specified NuGet package sources to use during the restore.
|
| TieredCompilation | bool? |
Gets or sets a value indicating whether tiered compilation is enabled.
|
| Tiered |
bool? |
Gets or sets a value as to whether tiered compilation quick JIT is enabled.
|
| 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.
|
| WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| 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
|
| 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
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException 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
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|
| With |
T |
Sets the tool argument customization delegate.
|
| With |
T |
Sets or adds tool environment variable.
|
| WithExpectedExitCode |
T |
Sets expected exit code using
WithHandleExitCode<T>(T, Func<int, bool>).
|
| WithHandleExitCode |
T |
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
|
| With |
T |
Sets whether the tool should use a working directory or not.
|
| WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
| With |
T |
Sets a delegate to configure the process settings.
|
| WithToolPath |
T |
Sets the tool path.
|
| WithToolSettings |
T |
Provides fluent null guarded tool settings action.
|
| WithToolTimeout |
T |
Sets the tool timeout.
|
| WithWorkingDirectory |
T |
Sets the tool working directory.
|