DotNetOutdatedSettings Class

Summary

Contains the settings shared by all dotnet-outdated commands.
Assembly
Cake.DotNetOutdated.dll
Namespace
Cake.DotNetOutdated
Base Types
  • ToolSettings
Derived Types
graph BT Type-->Base0["ToolSettings"] Type["DotNetOutdatedSettings"] class Type type-node Derived0["DotNetOutdatedUpgradeSettings"]-->Type click Derived0 "/api/Cake.DotNetOutdated/DotNetOutdatedUpgradeSettings" Derived1["DotNetOutdatedReportSettings"]-->Type click Derived1 "/api/Cake.DotNetOutdated/DotNetOutdatedReportSettings"

Syntax

public class DotNetOutdatedSettings : ToolSettings

Constructors

Name Summary
DotNetOutdatedSettings()

Properties

Name Value Summary
Exclude ICollection<string>
Gets or sets the package name filters to exclude; a package is excluded if its name contains any of them (--exclude).
IdleTimeout Nullable<int>
Gets or sets the idle timeout in seconds to wait for output from dotnet before assuming it has hung (--idle-timeout).
IgnoreFailedSources bool
Gets or sets a value indicating whether package source failures are treated as warnings (--ignore-failed-sources).
Include ICollection<string>
Gets or sets the package name filters to include; a package matches if its name contains any of them (--include).
IncludeAutoReferences bool
Gets or sets a value indicating whether auto-referenced packages are included (--include-auto-references).
IncludeFileBasedApps bool
Gets or sets a value indicating whether loose file-based apps are included in a recursive search (--include-file-based-apps).
MaximumVersion string
Gets or sets the inclusive maximum version to upgrade to, for example 8.0 (--maximum-version).
NuGetCredentialLogLevel Nullable<DotNetOutdatedCredentialLogLevel>
Gets or sets the minimum log level of the NuGet credential service (--nuget-cred-log-level).
OlderThan Nullable<int>
Gets or sets the minimum age in days of a package version to be considered (--older-than).
PreRelease Nullable<DotNetOutdatedPreRelease>
Gets or sets whether pre-release versions are considered (--pre-release).
PreReleaseLabel string
Gets or sets a label that pre-release versions must start with, for example rc.1 (--pre-release-label).
Recursive bool
Gets or sets a value indicating whether projects are searched for recursively (--recursive).
Runtime string
Gets or sets the runtime identifier used during restore (--runtime).
Transitive bool
Gets or sets a value indicating whether transitive dependencies are detected (--transitive).
TransitiveDepth Nullable<int>
Gets or sets how many levels deep transitive dependencies are analyzed (--transitive-depth).
VersionLock Nullable<DotNetOutdatedVersionLock>
Gets or sets whether packages are locked to their current major or minor version (--version-lock).

Extension Methods

Name Value Summary
Dump<DotNetOutdatedSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotNetOutdatedSettings>(DotNetOutdatedSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotNetOutdatedSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DotNetOutdatedSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<DotNetOutdatedSettings>(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
ThrowIfNull<DotNetOutdatedSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin