Summary

Contains settings used by NuGetPacker.

Namespace

Cake.Common.Tools.NuGet.Pack

Base Types

object
ToolSettings

graph BT Type-->Base0["ToolSettings"] click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base0-->Base1["object"] Type["NuGetPackSettings"] class Type type-node

Syntax

public sealed class NuGetPackSettings : ToolSettings

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
Authors	ICollection<string>	Gets or sets the package authors.
BasePath	DirectoryPath	Gets or sets the base path.
ContentFiles	ICollection<NuSpecContentFile>	Gets or sets the package content files.
Copyright	string	Gets or sets the package copyright.
Dependencies	ICollection<NuSpecDependency>	Gets or sets the package dependencies.
Description	string	Gets or sets the package description.
DevelopmentDependency	bool?	Gets or sets a value indicating whether this package should be marked as a development dependency.
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
Files	ICollection<NuSpecContent>	Gets or sets the package files.
FrameworkAssemblies	ICollection<NuSpecFrameworkAssembly>	Gets or sets the package framework assemblies.
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
Icon	string	Gets or sets the Icon path.
IconUrl	Uri	Gets or sets the package icon URL.
Id	string	Gets or sets the package ID.
IncludeReferencedProjects	bool	Gets or sets a value indicating whether referenced projects should be included. Defaults to `false`.
KeepTemporaryNuSpecFile	bool	Gets or sets a value indicating whether the temporarily autogenerated NuSpec file should be kept or not. Defaults to `false`.
Language	string	Gets or sets the package language.
License	NuSpecLicense	Gets or sets the package license.
LicenseUrl	Uri	Gets or sets the package license URL.
MinClientVersion	string	Gets or sets the package minimum client version.
MSBuildVersion	NuGetMSBuildVersion?	Gets or sets the version of MSBuild to be used with this command. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. This setting requires NuGet V3 or later.
NoPackageAnalysis	bool	Gets or sets a value indicating whether package analysis should be performed. Defaults to `true`.
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.
OutputToToolFolder	bool	Gets or sets a value indicating whether the files should be packed into the tool folder. Defaults to `false`.
Owners	ICollection<string>	Gets or sets the package owners.
PackageTypes	ICollection<NuSpecPackageType>	Gets or sets the package types.
PostAction	Action<IProcess>	Gets or sets a delegate which is executed after the process was started. Inherited from ToolSettings
ProjectUrl	Uri	Gets or sets the package project URL.
Properties	IDictionary<string, string>	Gets or sets the properties.
References	ICollection<NuSpecReference>	Gets or sets the package references.
ReleaseNotes	ICollection<string>	Gets or sets the package release notes.
Repository	NuGetRepository	Gets or sets the package repository data.
RequireLicenseAcceptance	bool?	Gets or sets a value indicating whether users has to accept the package license.
Serviceable	bool?	Gets or sets a value indicating whether this package should be marked as a serviceable.
SetupProcessSettings	Action<ProcessSettings>	Gets or sets a delegate to configure the process settings. Inherited from ToolSettings
Suffix	string	Gets or sets the nuspec version suffix.
Summary	string	Gets or sets the package summary.
SymbolPackageFormat	string	Gets or sets the symbol package format.
Symbols	bool	Gets or sets a value indicating whether a symbol package should be created. Defaults to `false`.
Tags	ICollection<string>	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
Verbosity	NuGetVerbosity?	Gets or sets the verbosity.
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<NuGetPackSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<NuGetPackSettings>(NuGetPackSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<NuGetPackSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<NuGetPackSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<NuGetPackSettings>(string, string)	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<NuGetPackSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
WithArgumentCustomization<NuGetPackSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>)	T	Sets the tool argument customization delegate. From ToolSettingsExtensions
WithEnvironmentVariable<NuGetPackSettings>(string, string)	T	Sets or adds tool environment variable. From ToolSettingsExtensions
WithExpectedExitCode<NuGetPackSettings>(int)	T	Sets expected exit code using `WithHandleExitCode<T>(T, Func<int, bool>)`. From ToolSettingsExtensions
WithHandleExitCode<NuGetPackSettings>(Func<int, bool>)	T	Sets delegate whether the exit code from the tool process causes an exception to be thrown. From ToolSettingsExtensions
WithNoWorkingDirectory<NuGetPackSettings>(bool)	T	Sets whether the tool should use a working directory or not. From ToolSettingsExtensions
WithPostAction<NuGetPackSettings>(Action<IProcess>)	T	Sets a delegate which is executed after the tool process was started. From ToolSettingsExtensions
WithSetupProcessSettings<NuGetPackSettings>(Action<ProcessSettings>)	T	Sets a delegate to configure the process settings. From ToolSettingsExtensions
WithToolPath<NuGetPackSettings>(FilePath)	T	Sets the tool path. From ToolSettingsExtensions
WithToolSettings<NuGetPackSettings>(Action<NuGetPackSettings>)	T	Provides fluent null guarded tool settings action. From ToolSettingsExtensions
WithToolTimeout<NuGetPackSettings>(TimeSpan)	T	Sets the tool timeout. From ToolSettingsExtensions
WithWorkingDirectory<NuGetPackSettings>(DirectoryPath)	T	Sets the tool working directory. From ToolSettingsExtensions

NuGetPackSettings Class

Summary

Syntax

Properties

Extension Methods