Summary
Represents the version-related configuration for a specific branch or branch pattern.
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
.Configuration - Interfaces
- Implementing Types
graph BT
Type-.->Interface0["ICalculationBranchConfiguration"]
click Interface0 "/api/GitVersion.Configuration/ICalculationBranchConfiguration"
Type-.->Interface1["IOutputBranchConfiguration"]
click Interface1 "/api/GitVersion.Configuration/IOutputBranchConfiguration"
Type["IBranchConfiguration"]
class Type type-node
Implementing0["IGitVersionConfiguration"]-.->Type
click Implementing0 "/api/GitVersion.Configuration/IGitVersionConfiguration"
Syntax
public interface IBranchConfiguration : ICalculationBranchConfiguration, IOutputBranchConfiguration
Attributes
| Type | Description |
|---|---|
| Nullable |
Properties
| Name | Value | Summary |
|---|---|---|
| Commit |
Nullable |
Gets the mode that controls how commit messages drive version increments.
|
| CustomVersionFormat | string |
Gets the format string used to compute the custom version output on this branch.
|
| 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.
|
| PreReleaseWeight | Nullable |
Gets the numeric weight applied to the pre-release tag number to produce a weighted pre-release number.
|
| 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.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Inherit |
IBranchConfiguration |
Returns a new configuration that inherits unset values from the given effective configuration.
|
| Inherit |
IBranchConfiguration |
Returns a new configuration that inherits unset values from configuration.
|
| IsMatch |
bool |
Returns whether the given branch name matches the
RegularExpression for this configuration. |
Extension Methods
| Name | Value | Summary |
|---|---|---|
| NotNull |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|