Summary
Contains settings used by
ChocolateyPacker.
- Namespace
- Cake
.Common .Tools .Chocolatey .Pack - Base Types
-
- object
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
click Base0 "/api/Cake.Core.Tooling/ToolSettings"
Base0-->Base1["object"]
Type["ChocolateyPackSettings"]
class Type type-node
Syntax
public sealed class ChocolateyPackSettings : ToolSettingsProperties
| Name | Value | Summary |
|---|---|---|
| AllowUnofficial | bool |
Gets or sets a value indicating whether to run in allow unofficial mode.
|
| 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.
|
| Copyright | string |
Gets or sets the package copyright.
|
| Debug | bool |
Gets or sets a value indicating whether to run in debug mode.
|
| 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.
|
| Files | ICollection |
Gets or sets the package files.
|
| Force | bool |
Gets or sets a value indicating whether to run in forced mode.
|
| 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.
|
| MailingListUrl | Uri |
Gets or sets the package mailing list URL.
|
| Noop | bool |
Gets or sets a value indicating whether to run in noop mode.
|
| 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.
|
| ProjectSourceUrl | Uri |
Gets or sets the package project Source URL.
|
| ProjectUrl | Uri |
Gets or sets the package project URL.
|
| 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.
|
| 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
|
| Verbose | bool |
Gets or sets a value indicating whether to run in verbose mode.
|
| 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 if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator 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
|