Summary
Represents the top-level GitVersion configuration, extending branch-level configuration with global settings.
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
.Configuration - Interfaces
graph BT
Type-.->Interface0["IBranchConfiguration"]
click Interface0 "/api/GitVersion.Configuration/IBranchConfiguration"
Type-.->Interface1["ICalculationBranchConfiguration"]
click Interface1 "/api/GitVersion.Configuration/ICalculationBranchConfiguration"
Type-.->Interface2["IOutputBranchConfiguration"]
click Interface2 "/api/GitVersion.Configuration/IOutputBranchConfiguration"
Type["IGitVersionConfiguration"]
class Type type-node
Syntax
public interface IGitVersionConfiguration : IBranchConfiguration, ICalculationBranchConfiguration,
IOutputBranchConfiguration
Attributes
| Type | Description |
|---|---|
| Nullable |
Properties
| Name | Value | Summary |
|---|---|---|
| Assembly |
string |
Gets the format string used to compute the assembly file version.
|
| Assembly |
Nullable |
Gets the scheme used to compute the
AssemblyFileVersionAttribute value. |
| Assembly |
string |
Gets the format string used to compute the
AssemblyInformationalVersionAttribute value. |
| Assembly |
string |
Gets the format string used to compute the assembly version.
|
| Assembly |
Nullable |
Gets the scheme used to compute the
AssemblyVersionAttribute value. |
| Branches | IReadOnlyDictionary |
Gets the per-branch configuration map, keyed by branch name pattern.
|
| Calculation | I |
Gets the settings that participate in semantic-version calculation.
|
| CommitDateFormat | string |
Gets the format string used when rendering commit dates in version output.
|
| 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.
|
| Output | IOutputConfiguration |
Gets the settings that affect rendered version output.
|
| 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.
|
| TagPreReleaseWeight | Nullable |
Gets the pre-release weight applied to tagged commits when calculating the weighted pre-release number.
|
| UpdateBuildNumber | bool |
Gets a value indicating whether the build number in the CI system should be updated.
|
| 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.
|
| Workflow | string |
Gets the name of the workflow preset (e.g.
GitFlow/v1 or GitHubFlow/v1) used as a base configuration. |
Methods
| Name | Value | Summary |
|---|---|---|
| Get |
IBranchConfiguration |
Returns an empty branch configuration that carries no values.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| NotNull |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|