IGitVersionConfiguration Interface

Summary

Represents the top-level GitVersion configuration, extending branch-level configuration with global settings.
Namespace
GitVersion.Configuration
Interfaces
graph BT Type-.->Interface0["IBranchConfiguration"] click Interface0 "/api/GitVersion.Configuration/IBranchConfiguration" Type["IGitVersionConfiguration"] class Type type-node

Syntax

public interface IGitVersionConfiguration : IBranchConfiguration

Properties

Name Value Summary
AssemblyFileVersioningFormat string
Gets the format string used to compute the assembly file version.
AssemblyFileVersioningScheme AssemblyFileVersioningScheme?
Gets the scheme used to compute the AssemblyFileVersionAttribute value.
AssemblyInformationalFormat string
Gets the format string used to compute the AssemblyInformationalVersionAttribute value.
AssemblyVersioningFormat string
Gets the format string used to compute the assembly version.
AssemblyVersioningScheme AssemblyVersioningScheme?
Gets the scheme used to compute the AssemblyVersionAttribute value.
Branches IReadOnlyDictionary<string, IBranchConfiguration>
Gets the per-branch configuration map, keyed by branch name pattern.
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.
MajorVersionBumpMessage string
Gets the commit message pattern that triggers a major version bump.
MergeMessageFormats IReadOnlyDictionary<string, string>
Gets a dictionary of named regex patterns for recognising merge commit message formats.
MinorVersionBumpMessage 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.
PatchVersionBumpMessage string
Gets the commit message pattern that triggers a patch version bump.
SemanticVersionFormat SemanticVersionFormat
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.
UpdateBuildNumber bool
Gets a value indicating whether the build number in the CI system should be updated.
VersionInBranchPattern 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
GetEmptyBranchConfiguration() IBranchConfiguration
Returns an empty branch configuration that carries no values.

Extension Methods

Name Value Summary
NotNull<IGitVersionConfiguration>(string) T
Throws ArgumentNullException when value is null; otherwise returns the value.
GitHub