NuGetPackSettings Class

Summary

Contains settings used by NuGetPacker.
Namespace
Cake.Common.Tools.NuGet.Pack
Base Types
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.
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.
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.
Suffix string
Gets or sets the nuspec version suffix.
Summary string
Gets or sets the package summary.
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.
Requires the Cake.Incubator addin
IsIn<NuGetPackSettings>(NuGetPackSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NuGetPackSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NuGetPackSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<NuGetPackSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NuGetPackSettings>(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