Summary
Contains settings used by
ChocolateyPacker.
- Namespace
- Cake
.Common .Tools .Chocolatey .Pack - Base Types
-
- object
- ToolSettings
- ChocolateySettings
graph BT
Type-->Base0["ChocolateySettings"]
click Base0 "/api/Cake.Common.Tools.Chocolatey/ChocolateySettings"
Base0-->Base1["ToolSettings"]
click Base1 "/api/Cake.Core.Tooling/ToolSettings"
Base1-->Base2["object"]
Type["ChocolateyPackSettings"]
class Type type-node
Syntax
public sealed class ChocolateyPackSettings : ChocolateySettingsProperties
| Name | Value | Summary |
|---|---|---|
| AcceptLicense | bool |
Gets or sets a value indicating whether to accept license for package.
Inherited from ChocolateySettings
|
| AllowUnofficial | bool |
Gets or sets a value indicating whether to run in allow unofficial mode.
Inherited from ChocolateySettings
|
| 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
|
| Authors | ICollection |
Gets or sets the package authors.
|
| BugTrackerUrl | Uri |
Gets or sets the package bug tracker URL.
|
| CacheLocation | string |
Gets or sets the location of the download cache.
Inherited from ChocolateySettings
|
| Copyright | string |
Gets or sets the package copyright.
|
| Debug | bool |
Gets or sets a value indicating whether to run in debug mode.
Inherited from ChocolateySettings
|
| Dependencies | ICollection |
Gets or sets the package dependencies.
|
| Description | string |
Gets or sets the package description.
|
| DocsUrl | Uri |
Gets or sets the package documentation URL.
|
| EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
| ExecutionTimeout | int |
Gets or sets the execution timeout value.
Inherited from ChocolateySettings
|
| FailOnErrorOutput | bool |
Gets or sets a value indicating whether to faile when error output is detected.
Inherited from ChocolateySettings
|
| Files | ICollection |
Gets or sets the package files.
|
| Force | bool |
Gets or sets a value indicating whether to run in forced mode.
Inherited from ChocolateySettings
|
| 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
|
| IconUrl | Uri |
Gets or sets the package icon URL.
|
| Id | string |
Gets or sets the package ID.
|
| LicenseUrl | Uri |
Gets or sets the package license URL.
|
| LimitOutput | bool |
Gets or sets a value indicating whether to run in limited output mode.
Inherited from ChocolateySettings
|
| LogFile | FilePath |
Gets or sets the path to the file where all log entries will be sent.
Inherited from ChocolateySettings
|
| MailingListUrl | Uri |
Gets or sets the package mailing list URL.
|
| NoColor | bool |
Gets or sets a value indicating whether to run in no color mode.
Inherited from ChocolateySettings
|
| Noop | bool |
Gets or sets a value indicating whether to run in noop mode.
Inherited from ChocolateySettings
|
| NoProgress | bool |
Gets or sets a value indicating whether to run while not showing download progress.
Inherited from ChocolateySettings
|
| 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 a value indicating the Working Directory that should be used while running choco.exe.
|
| Owners | ICollection |
Gets or sets the package owners.
|
| PackageSourceUrl | Uri |
Gets or sets the package Source URL.
|
| PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
| ProjectSourceUrl | Uri |
Gets or sets the package project Source URL.
|
| ProjectUrl | Uri |
Gets or sets the package project URL.
|
| Proxy | string |
Gets or sets the explicit proxy location.
Inherited from ChocolateySettings
|
| ProxyByPassList | string |
Gets or sets the comma separated list of regex location to bypass on proxy.
Inherited from ChocolateySettings
|
| ProxyBypassOnLocal | bool |
Gets or sets a value indicating whether to bypass proxy for local connections.
Inherited from ChocolateySettings
|
| ProxyPassword | string |
Gets or sets the explicit proxy password.
Inherited from ChocolateySettings
|
| ProxyUser | string |
Gets or sets the explicit proxy user.
Inherited from ChocolateySettings
|
| ReleaseNotes | ICollection |
Gets or sets the package release notes.
|
| Require |
bool |
Gets or sets a value indicating whether users has to accept the package license.
|
| SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
| Skip |
bool |
Gets or sets a value indicating whether to skip all compatibility checks.
Inherited from ChocolateySettings
|
| Summary | string |
Gets or sets the package summary.
|
| Tags | ICollection |
Gets or sets the package tags.
|
| Title | string |
Gets or sets the package title.
|
| ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
| ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
| Trace | bool |
Gets or sets a value indicating whether to run in trace mode.
Inherited from ChocolateySettings
|
| UseSystemPowerShell | bool |
Gets or sets a value indicating whether to run using system installed version of PowerShell.
Inherited from ChocolateySettings
|
| Verbose | bool |
Gets or sets a value indicating whether to run in verbose mode.
Inherited from ChocolateySettings
|
| Version | string |
Gets or sets the Nuspec version.
|
| 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 Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues 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.
|