MinVerSettings Class

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.MinVer.

Summary

Contains settings used by MinVerTool.

Assembly

Cake.MinVer.dll

Namespace

Interfaces

ICloneable

Base Types

DotNetSettings

graph BT Type-->Base0["DotNetSettings"] Type-.->Interface0["ICloneable"] Type["MinVerSettings"] class Type type-node

Syntax

public class MinVerSettings : DotNetSettings, ICloneable

Constructors

Name	Summary
MinVerSettings()

Properties

Name	Value	Summary
AutoIncrement	Nullable<MinVerAutoIncrement>	Set the version part to be automatically incremented. --auto-increment <VERSION_PART> major, minor, or patch (default)
BuildMetadata	string	Set the build metadata. --build-metadata <BUILD_METADATA>
DefaultPreReleasePhase	string	Set the default pre-release phase. --default-pre-release-phase <PHASE> alpha (default), preview, etc.
MinimumMajorMinor	string	Set the minimum major and minor version. --minimum-major-minor <MINIMUM_MAJOR_MINOR> 1.0, 1.1, 2.0, etc.
NoFallback	Nullable<bool>	By default, MinVer is executed as a local tool first() and, in case of error, fallback to global tool() Set `NoFallback` to to disable the fallback in case of an error (*) Unless `PreferGlobalTool` is set to , in which case MinVer is executed as a global tool first and, in case of an error, fallback to local tool Local tool = `dotnet minver` Global tool = `minver`
PreferGlobalTool	Nullable<bool>	By default, MinVer is executed as a local tool first and, in case of error, fallback() to global tool Set `PreferGlobalTool` to to execute MinVer as global tool first and, in case of an error, fallback() to local tool (*) Unless the fallback is disabled via `NoFallback` Local tool = `dotnet minver` Global tool = `minver`
Repo	DirectoryPath	Set the working directory for MinVer to use. --repo <REPO>
TagPrefix	string	Set the tag prefix. --tag-prefix <TAG_PREFIX>
Verbosity	Nullable<MinVerVerbosity>	Set the verbosity. --verbosity <VERBOSITY> error, warn, info (default), debug, or trace

Methods

Name	Value	Summary
Clone()	MinVerSettings	Creates a shallow clone of this `MinVerSettings` instance

Extension Methods

Name	Value	Summary
Dump<MinVerSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
FromPath(DirectoryPath)	MinVerSettings	Sets the working directory which should be used to run the MinVer tool. From MinVerSettingsExtensions Requires the Cake.MinVer addin
IsIn<MinVerSettings>(MinVerSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MinVerSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<MinVerSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<MinVerSettings>(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<MinVerSettings>(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
WithAutoIncrement(MinVerAutoIncrement)	MinVerSettings	Set the version part to be automatically incremented. --auto-increment <VERSION_PART> major, minor, or patch (default) From MinVerSettingsExtensions Requires the Cake.MinVer addin
WithBuildMetadata(string)	MinVerSettings	Set the build metadata. --build-metadata <BUILD_METADATA> From MinVerSettingsExtensions Requires the Cake.MinVer addin
WithDefaultPreReleasePhase(string)	MinVerSettings	Set the default pre-release phase. --default-pre-release-phase <PHASE> alpha (default), preview, etc. From MinVerSettingsExtensions Requires the Cake.MinVer addin
WithMinimumMajorMinor(string)	MinVerSettings	Set the minimum major and minor version. --minimum-major-minor <MINIMUM_MAJOR_MINOR> 1.0, 1.1, 2.0, etc. From MinVerSettingsExtensions Requires the Cake.MinVer addin
WithNoFallback()	MinVerSettings	By default, MinVer is executed as a local tool first() and, in case of error, fallback to global tool() Set `NoFallback` to to disable the fallback in case of an error () Unless `PreferGlobalTool` is set to , in which case MinVer is executed as a global tool first and, in case of an error, fallback to local tool Local tool = `dotnet minver` Global tool = `minver` From MinVerSettingsExtensions* Requires the Cake.MinVer addin
WithPreferGlobalTool()	MinVerSettings	By default, MinVer is executed as a local tool first and, in case of error, fallback() to global tool Set `PreferGlobalTool` to to execute MinVer as global tool first and, in case of an error, fallback() to local tool () Unless the fallback is disabled via `NoFallback` Local tool = `dotnet minver` Global tool = `minver` From MinVerSettingsExtensions* Requires the Cake.MinVer addin
WithRepo(DirectoryPath)	MinVerSettings	Set the working directory for MinVer to use. --repo <REPO> From MinVerSettingsExtensions Requires the Cake.MinVer addin
WithTagPrefix(string)	MinVerSettings	Set the tag prefix. --tag-prefix <TAG_PREFIX> From MinVerSettingsExtensions Requires the Cake.MinVer addin
WithToolPath(FilePath)	MinVerSettings	Set a custom path to the minver.exe file. From MinVerSettingsExtensions Requires the Cake.MinVer addin
WithVerbosity(MinVerVerbosity)	MinVerSettings	Set the verbosity. --verbosity <VERBOSITY> error, warn, info (default), debug, or trace From MinVerSettingsExtensions Requires the Cake.MinVer addin