Summary
Represents branch settings that affect semantic-version calculation.
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
.Configuration - Implementing Types
graph BT
Type["ICalculationBranchConfiguration"]
class Type type-node
Implementing0["IGitVersionConfiguration"]-.->Type
click Implementing0 "/api/GitVersion.Configuration/IGitVersionConfiguration"
Implementing1["IBranchConfiguration"]-.->Type
click Implementing1 "/api/GitVersion.Configuration/IBranchConfiguration"
Implementing2["ICalculationConfiguration"]-.->Type
click Implementing2 "/api/GitVersion.Configuration/ICalculationConfiguration"
Syntax
public interface ICalculationBranchConfiguration
Attributes
| Type | Description |
|---|---|
| Nullable |
Properties
| Name | Value | Summary |
|---|---|---|
| Commit |
Nullable |
Gets the mode that controls how commit messages drive version increments.
|
| DeploymentMode | Nullable |
Gets the deployment mode used to compute versions on this branch.
|
| Increment | IncrementStrategy |
Gets the version field that is incremented when creating a new release from this branch.
|
| IsMainBranch | Nullable |
Gets a value indicating whether this branch is treated as a main/trunk branch.
|
| IsReleaseBranch | Nullable |
Gets a value indicating whether this branch is a release branch.
|
| IsSourceBranchFor | IReadOnlyCollection |
Gets the names of branches for which this branch may act as a source.
|
| Label | string |
Gets the pre-release label applied to versions produced on this branch.
|
| PreventIncrement | I |
Gets the configuration that controls under what conditions automatic version increments are suppressed.
|
| RegularExpression | string |
Gets the regular expression that matches branch names eligible for this configuration.
|
| SourceBranches | IReadOnlyCollection |
Gets the names of branches that this branch may be branched from.
|
| TrackMergeMessage | Nullable |
Gets a value indicating whether merge commit messages are considered when determining version increments.
|
| TrackMergeTarget | Nullable |
Gets a value indicating whether to track the merge target branch for version calculation.
|
| Tracks |
Nullable |
Gets a value indicating whether this branch tracks release branches.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| NotNull |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|