MinVerSettingsExtensions Class

Summary

Extensions for MinVerSettings.
Assembly
Cake.MinVer.dll
Namespace
Cake.MinVer
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["MinVerSettingsExtensions"] class Type type-node

Syntax

public static class MinVerSettingsExtensions

Methods

Name Value Summary
FromPath(MinVerSettings, DirectoryPath) MinVerSettings
Sets the working directory which should be used to run the MinVer tool.
static
WithAutoIncrement(MinVerSettings, MinVerAutoIncrement) MinVerSettings
Set the version part to be automatically incremented. --auto-increment <VERSION_PART> major, minor, or patch (default)
static
WithBuildMetadata(MinVerSettings, string) MinVerSettings
Set the build metadata. --build-metadata <BUILD_METADATA>
static
WithDefaultPreReleasePhase(MinVerSettings, string) MinVerSettings
Set the default pre-release phase. --default-pre-release-phase <PHASE> alpha (default), preview, etc.
static
WithMinimumMajorMinor(MinVerSettings, string) MinVerSettings
Set the minimum major and minor version. --minimum-major-minor <MINIMUM_MAJOR_MINOR> 1.0, 1.1, 2.0, etc.
static
WithNoFallback(MinVerSettings) 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`
static
WithPreferGlobalTool(MinVerSettings) 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`
static
WithRepo(MinVerSettings, DirectoryPath) MinVerSettings
Set the working directory for MinVer to use. --repo <REPO>
static
WithTagPrefix(MinVerSettings, string) MinVerSettings
Set the tag prefix. --tag-prefix <TAG_PREFIX>
static
WithToolPath(MinVerSettings, FilePath) MinVerSettings
Set a custom path to the minver.exe file.
static
WithVerbosity(MinVerSettings, MinVerVerbosity) MinVerSettings
Set the verbosity. --verbosity <VERBOSITY> error, warn, info (default), debug, or trace
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin