MinVerSettings Class

Summary

Contains settings used by MinVerTool.
Assembly
Cake.MinVer.dll
Namespace
Cake.MinVer
Base Types
  • DotNetCoreSettings
graph BT Type-->Base0["DotNetCoreSettings"] Type["MinVerSettings"] class Type type-node

Syntax

public class MinVerSettings : DotNetCoreSettings

Constructors

Name Summary
MinVerSettings()

Properties

Name Value Summary
AutoIncrement 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.
Repo DirectoryPath
Set the working directory for MinVer to use. --repo <REPO>
TagPrefix string
Set the tag prefix. --tag-prefix <TAG_PREFIX>
Verbosity MinVerVerbosity
Set the verbosity. --verbosity <VERBOSITY> error, warn, info (default), debug, or trace

Extension Methods

Name Value Summary
Dump<MinVerSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
FromPath(DirectoryPath) MinVerSettings
Sets the working directory which should be used to run the MinVer tool.
Requires the Cake.MinVer addin
IsIn<MinVerSettings>(MinVerSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MinVerSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<MinVerSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<MinVerSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MinVerSettings>(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
WithAutoIncrement(MinVerAutoIncrement) MinVerSettings
Set the version part to be automatically incremented. --auto-increment <VERSION_PART> major, minor, or patch (default)
Requires the Cake.MinVer addin
WithBuildMetadata(string) MinVerSettings
Set the build metadata. --build-metadata <BUILD_METADATA>
Requires the Cake.MinVer addin
WithDefaultPreReleasePhase(string) MinVerSettings
Set the default pre-release phase. --default-pre-release-phase <PHASE> alpha (default), preview, etc.
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.
Requires the Cake.MinVer addin
WithRepo(DirectoryPath) MinVerSettings
Set the working directory for MinVer to use. --repo <REPO>
Requires the Cake.MinVer addin
WithTagPrefix(string) MinVerSettings
Set the tag prefix. --tag-prefix <TAG_PREFIX>
Requires the Cake.MinVer addin
WithVerbosity(MinVerVerbosity) MinVerSettings
Set the verbosity. --verbosity <VERBOSITY> error, warn, info (default), debug, or trace
Requires the Cake.MinVer addin