ICalculationConfiguration Interface

Summary

Represents settings that participate in semantic-version calculation.
graph BT Type-.->Interface0["ICalculationBranchConfiguration"] click Interface0 "/api/GitVersion.Configuration/ICalculationBranchConfiguration" Type["ICalculationConfiguration"] class Type type-node

Syntax

public interface ICalculationConfiguration : ICalculationBranchConfiguration

Attributes

Type Description
NullableContextAttribute

Properties

Name Value Summary
Branches IReadOnlyDictionary<string, ICalculationBranchConfiguration>
Gets calculation settings for each configured branch.
Ignore IIgnoreConfiguration
Gets the configuration that controls which commits and time ranges are ignored during version calculation.
MajorVersionBumpMessage string
Gets the commit message pattern that triggers a major version bump.
MergeMessageFormats IReadOnlyDictionary<string, string>
Gets a dictionary of named regex patterns for recognising merge commit message formats.
MinorVersionBumpMessage string
Gets the commit message pattern that triggers a minor version bump.
NextVersion string
Gets the manually configured next version, overriding automatic calculation.
NoBumpMessage string
Gets the commit message pattern that suppresses any version bump.
PatchVersionBumpMessage string
Gets the commit message pattern that triggers a patch version bump.
SemanticVersionFormat SemanticVersionFormat
Gets the semantic version format (strict or loose) used when parsing version strings.
TagPrefixPattern string
Gets the regex pattern that identifies tag prefixes to strip when parsing version tags.
VersionBumpResetMessage string
Gets the commit message pattern that resets the version bump baseline.
VersionInBranchPattern string
Gets the regex pattern used to extract a semantic version from a branch name.
VersionStrategy VersionStrategies
Gets the set of version strategies enabled for this configuration.

Extension Methods

Name Value Summary
NotNull<ICalculationConfiguration>(string) T
Throws System.ArgumentNullException when value is null; otherwise returns the value.