BuildNugetVersionFromBranchSettings Class

Summary

Settings how to convert branch name to version suffix
Assembly
Cake.Nuget.Versioning.dll
Namespace
Cake.Nuget.Versioning
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type["BuildNugetVersionFromBranchSettings"] class Type type-node Derived0["BuildNugetVersionFromBranchSemVer200Settings"]-->Type click Derived0 "/api/Cake.Nuget.Versioning/BuildNugetVersionFromBranchSemVer200Settings"

Syntax

public class BuildNugetVersionFromBranchSettings

Constructors

Name Summary
BuildNugetVersionFromBranchSettings()

Properties

Name Value Summary
AlwaysApplyBranchPrefix bool
By default branch prefix is only applied when the branch name is not complatible as a version suffix. Eg. starts with numbers. If true branch prefix is always applied. Default value: false
BranchName string
The name of the branch
BranchPrefix string
Branch prefix what is applied as a prefix before the branch name Default value: b-
FilterGitReferences bool
If true "refs/heads/", "refs/tags/" and "refs/remotes/" are trimmed from the beginning of the branch name. Default value: true
PreReleaseFilters string[]
If the branch name match with one of the regexp in this array, the branch is identified as a final branch. The version won't contain pre-release suffix. Default value: new[] { "^master$" }
TrimPatterns string[]
Regexp patterns which are trimmed off from the branch name. Default value: null

Extension Methods

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