Summary
Represents settings that participate in semantic-version calculation.
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
.Configuration - Interfaces
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 |
|---|---|
| Nullable |
Properties
| Name | Value | Summary |
|---|---|---|
| Branches | IReadOnlyDictionary |
Gets calculation settings for each configured branch.
|
| Ignore | IIgnoreConfiguration |
Gets the configuration that controls which commits and time ranges are ignored during version calculation.
|
| Major |
string |
Gets the commit message pattern that triggers a major version bump.
|
| MergeMessageFormats | IReadOnlyDictionary |
Gets a dictionary of named regex patterns for recognising merge commit message formats.
|
| Minor |
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.
|
| Patch |
string |
Gets the commit message pattern that triggers a patch version bump.
|
| Semantic |
Semantic |
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.
|
| Version |
string |
Gets the commit message pattern that resets the version bump baseline.
|
| Version |
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 |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|