DotNetOutdatedReportSettings Class

Summary

Contains the settings used by the report command (dotnet outdated).
Assembly
Cake.DotNetOutdated.dll
Namespace
Cake.DotNetOutdated
Base Types
graph BT Type-->Base0["DotNetOutdatedSettings"] click Base0 "/api/Cake.DotNetOutdated/DotNetOutdatedSettings" Base0-->Base1["ToolSettings"] Type["DotNetOutdatedReportSettings"] class Type type-node

Syntax

public class DotNetOutdatedReportSettings : DotNetOutdatedSettings

Constructors

Name Summary
DotNetOutdatedReportSettings()

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).
Inherited from DotNetOutdatedSettings
FailOnUpdates bool
Gets or sets a value indicating whether the tool exits with code 2 when updates are found (--fail-on-updates). Cake treats any non-zero exit code as a failure unless HandleExitCode accepts it.
IdleTimeout Nullable<int>
Gets or sets the idle timeout in seconds to wait for output from dotnet before assuming it has hung (--idle-timeout).
Inherited from DotNetOutdatedSettings
IgnoreFailedSources bool
Gets or sets a value indicating whether package source failures are treated as warnings (--ignore-failed-sources).
Inherited from DotNetOutdatedSettings
Include ICollection<string>
Gets or sets the package name filters to include; a package matches if its name contains any of them (--include).
Inherited from DotNetOutdatedSettings
IncludeAutoReferences bool
Gets or sets a value indicating whether auto-referenced packages are included (--include-auto-references).
Inherited from DotNetOutdatedSettings
IncludeFileBasedApps bool
Gets or sets a value indicating whether loose file-based apps are included in a recursive search (--include-file-based-apps).
Inherited from DotNetOutdatedSettings
IncludeUpToDate bool
Gets or sets a value indicating whether all dependencies are reported, including up-to-date ones (--include-up-to-date).
MaximumVersion string
Gets or sets the inclusive maximum version to upgrade to, for example 8.0 (--maximum-version).
Inherited from DotNetOutdatedSettings
NuGetCredentialLogLevel Nullable<DotNetOutdatedCredentialLogLevel>
Gets or sets the minimum log level of the NuGet credential service (--nuget-cred-log-level).
Inherited from DotNetOutdatedSettings
OlderThan Nullable<int>
Gets or sets the minimum age in days of a package version to be considered (--older-than).
Inherited from DotNetOutdatedSettings
OutputFile FilePath
Gets or sets the file to save the report to (--output). Relative paths are resolved against the Cake working directory.
OutputFormat Nullable<DotNetOutdatedOutputFormat>
Gets or sets the format of the report file (--output-format).
PreRelease Nullable<DotNetOutdatedPreRelease>
Gets or sets whether pre-release versions are considered (--pre-release).
Inherited from DotNetOutdatedSettings
PreReleaseLabel string
Gets or sets a label that pre-release versions must start with, for example rc.1 (--pre-release-label).
Inherited from DotNetOutdatedSettings
Recursive bool
Gets or sets a value indicating whether projects are searched for recursively (--recursive).
Inherited from DotNetOutdatedSettings
Runtime string
Gets or sets the runtime identifier used during restore (--runtime).
Inherited from DotNetOutdatedSettings
Transitive bool
Gets or sets a value indicating whether transitive dependencies are detected (--transitive).
Inherited from DotNetOutdatedSettings
TransitiveDepth Nullable<int>
Gets or sets how many levels deep transitive dependencies are analyzed (--transitive-depth).
Inherited from DotNetOutdatedSettings
VersionLock Nullable<DotNetOutdatedVersionLock>
Gets or sets whether packages are locked to their current major or minor version (--version-lock).
Inherited from DotNetOutdatedSettings

Extension Methods

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