Header menu logo Partas.GitNet

BumpMatcher Type

Strategies for determining whether a commit will result in a specified bump type.

Union cases

Union case Description

DescriptionRegex string

Full Usage: DescriptionRegex string

Parameters:
    Item : string

Regex string applied to the subject.

Item : string

FooterKey string

Full Usage: FooterKey string

Parameters:
    Item : string

Whether a specific footer is present

Item : string

FooterKeyValue(string, string)

Full Usage: FooterKeyValue(string, string)

Parameters:
    Item1 : string
    Item2 : string

Same as FooterKey at the moment.

Item1 : string
Item2 : string

Type string

Full Usage: Type string

Parameters:
    Item : string

ConventionalCommit types

Item : string

TypeDescription(typ, descriptionRegex)

Full Usage: TypeDescription(typ, descriptionRegex)

Parameters:
    typ : string
    descriptionRegex : string

Match against a type, and then apply a regex to the subject as an OR op

typ : string
descriptionRegex : string

TypeFooterKey(typ, footerKey)

Full Usage: TypeFooterKey(typ, footerKey)

Parameters:
    typ : string
    footerKey : string

Match against a type, and then the footer key as an OR op

typ : string
footerKey : string

TypeFooterValue(typ, footerKey, footerValue)

Full Usage: TypeFooterValue(typ, footerKey, footerValue)

Parameters:
    typ : string
    footerKey : string
    footerValue : string

Match against a type, and then the footer as an OR op (value ignored at the moment).

typ : string
footerKey : string
footerValue : string

Instance members

Instance member Description

this.IsDescriptionRegex

Full Usage: this.IsDescriptionRegex

Returns: bool
Returns: bool

this.IsFooterKey

Full Usage: this.IsFooterKey

Returns: bool
Returns: bool

this.IsFooterKeyValue

Full Usage: this.IsFooterKeyValue

Returns: bool
Returns: bool

this.IsType

Full Usage: this.IsType

Returns: bool
Returns: bool

this.IsTypeDescription

Full Usage: this.IsTypeDescription

Returns: bool
Returns: bool

this.IsTypeFooterKey

Full Usage: this.IsTypeFooterKey

Returns: bool
Returns: bool

this.IsTypeFooterValue

Full Usage: this.IsTypeFooterValue

Returns: bool
Returns: bool

Type something to start searching.