Summary
Configuration can be applied to different things, effective configuration is the result after applying the
appropriate configuration
- Assembly
- GitVersion
.Core .dll - Namespace
- GitVersion
.Configuration - Interfaces
-
- IEquatable
<Effective Configuration >
- IEquatable
- Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type-.->Interface0["IEquatable<EffectiveConfiguration>"]
Type["EffectiveConfiguration"]
class Type type-node
Syntax
public class EffectiveConfiguration : IEquatable<EffectiveConfiguration>
Attributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
Constructors
| Name | Summary |
|---|---|
| Effective | |
| Effective | Initializes a new EffectiveConfiguration by merging global and branch-level configuration values. |
Properties
| Name | Value | Summary |
|---|---|---|
| Assembly |
string |
Gets the format string used to compute the assembly file version.
|
| Assembly |
Assembly |
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 |
Assembly |
Gets the scheme used to compute the
AssemblyVersionAttribute value. |
| CommitDateFormat | string |
Gets the format string used when rendering the commit date in version output.
|
| Commit |
Commit |
Gets the mode that controls how commit messages are used to determine version increments.
|
| CustomVersionFormat | string |
Gets the format string used to compute the custom version output.
|
| DeploymentMode | DeploymentMode |
Gets the deployment mode used to calculate the next version.
|
| EqualityContract | Type | |
| Ignore | IIgnoreConfiguration |
Gets the configuration that controls which commits and time ranges are ignored during version calculation.
|
| Increment | IncrementStrategy |
Gets the version field incremented when creating a new release from this branch.
|
| IsMainBranch | bool |
Gets a value indicating whether this branch is a main/trunk branch.
|
| IsReleaseBranch | bool |
Gets a value indicating whether this branch is a release branch.
|
| Label | string |
Gets the pre-release label applied to versions on this branch.
|
| Major |
string |
Gets the commit message pattern that triggers a major version bump.
|
| 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.
|
| PreReleaseWeight | int |
Gets the numeric weight applied to the pre-release tag number to produce a weighted pre-release number.
|
| Prevent |
bool |
Gets a value indicating whether incrementing the version of a merged branch is prevented.
|
| Prevent |
bool |
Gets a value indicating whether incrementing when the branch itself is merged is prevented.
|
| Prevent |
bool |
Gets a value indicating whether incrementing is prevented when the current commit is already tagged.
|
| RegularExpression | string |
Gets the regular expression that matches branch names eligible for this configuration.
|
| 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 | int |
Gets the pre-release weight applied to tagged commits when calculating the weighted pre-release number.
|
| TrackMergeMessage | bool |
Gets a value indicating whether merge commit messages are used to determine version increments.
|
| TrackMergeTarget | bool |
Gets a value indicating whether to track the merge target branch for version calculation.
|
| Tracks |
bool |
Gets a value indicating whether this branch tracks release branches.
|
| 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.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Equals |
bool | |
| Equals |
bool | |
| GetHashCode |
int | |
| PrintMembers |
bool | |
| ToString |
string |
Operators
| Name | Value | Summary |
|---|---|---|
| operator != |
bool | |
| operator == |
bool |
Extension Methods
| Name | Value | Summary |
|---|---|---|
| NotNull |
T |
Throws
System.ArgumentNullException when value is null; otherwise returns the value.From CommonExtensions
|