GitVersion.Core.dll Assembly

Class Types

Class Summary
AssemblyFileVersioningScheme Determines which version components are included in the assembly file version (AssemblyFileVersionAttribute).
AssemblySettingsInfo Contains options that control how GitVersion updates assembly version attributes and project files.
AssemblyVersioningScheme Determines which version components are included in the assembly version (AssemblyVersionAttribute).
AssemblyVersionsGeneratorExtensions Extension methods on SemanticVersion for generating assembly version strings.
AuthenticationInfo Holds credentials used when authenticating with a remote Git repository.
BaseVersion Represents a resolved base version consisting of an operand (the discovered version) and an optional operator (the increment to apply).
BaseVersionOperand Represents the discovered base version — the semantic version value and the commit it was found at.
BaseVersionOperator Describes the version increment operation that should be applied to a BaseVersionOperand to produce the next version.
BranchCommit A commit, together with the branch to which the commit belongs.
BugException Indicates an internal logic error that should never occur in normal usage; represents a bug in GitVersion itself.
CommitFilter Specifies criteria used to filter and order commits when querying a commit collection.
CommitMessageIncrement Represents a version increment selected from a commit message and whether prior increments must be reset.
CommitMessageIncrementMode Controls whether and how commit messages are used to determine automatic version increments.
CommitSortStrategies Specifies how commits are ordered when traversing the commit graph.
CommonExtensions General-purpose extension and guard methods used throughout GitVersion.
ConfigurationInfo Holds options that control how the GitVersion configuration file is located and applied.
ConfigurationMigrationInfo Settings that control a configuration migration operation.
DeploymentMode Specifies the deployment strategy used to determine how the version number changes between releases.
Disposable Factory methods for creating lightweight System.IDisposable wrappers around cleanup actions.
EffectiveBranchConfiguration Associates an EffectiveConfiguration with the branch it was resolved for.
EffectiveConfiguration Configuration can be applied to different things, effective configuration is the result after applying the appropriate configuration
EnumerableExtensions Extension methods that augment System.Collections.Generic.IEnumerable`1 and related collection types.
FileSystemExtensions Extension methods on System.IO.Abstractions.IFileSystem for common file-system operations.
FileWriteInfo Describes the working directory and file name details for writing version output to a file.
GitExtensions Extension and utility methods that supplement Git-related operations.
GitVersionCacheKey Represents the cache key used to identify a stored set of GitVersionVariables on disk.
GitVersionCommonModule Registers common infrastructure services such as logging, file system, environment, and build-agent resolution.
GitVersionContext Contextual information about where GitVersion is being run
GitVersionCoreModule Registers the core GitVersion services including version calculation, repository access, and caching.
GitVersionException Base exception type for errors raised by GitVersion during normal operation.
GitVersionOptions Top-level options object that aggregates all settings used to configure a GitVersion execution.
GitVersionVariables Contains all version variables calculated by GitVersion for a given repository state.
IncrementStrategy Specifies which version component should be incremented when creating a release from a branch.
IncrementStrategyExtensions Extension methods on IncrementStrategy for converting to related types.
LambdaEqualityHelper<T> Provides equality and hash-code implementation for T based on a set of key-selector functions.
LambdaKeyComparer<TSource, TKey> A System.Collections.Generic.Comparer`1 that delegates comparison to a key-selector function, with an optional inner comparer for the key type.
LockedFileException Raised when a file cannot be accessed because it is locked by another process.
MergeMessage Parses the message of a merge commit to extract the merged branch name, target branch, pull-request number, and embedded semantic version.
NextVersion Represents the next calculated version together with its base version and branch configuration.
OutputType Specifies the format in which GitVersion outputs version variables.
ReadEmbeddedResourceExtensions Extension methods on string for reading embedded assembly resources.
ReferenceName Represents a Git reference name in both its canonical (refs/heads/main) and friendly (main) forms.
ReferenceNameExtensions Extension methods on ReferenceName for semantic-version extraction.
RefSpecDirection Indicates the direction of a refspec mapping.
RepositoryInfo Identifies the remote repository and the specific commit or branch to version.
RetryAction<T, Result> Executes a function with automatic linear-backoff retries when a T exception is thrown.
RetryAction<T> Executes an action with automatic linear-backoff retries when a T exception is thrown, discarding the return value.
SemanticVersion Represents a semantic version with optional pre-release tag and build metadata.
SemanticVersion.IncrementMode Controls how version incrementing is applied.
SemanticVersionBuildMetaData Holds the build metadata attached to a semantic version (commits-since-tag, branch, SHA, commit date, etc.).
SemanticVersionFormat Controls the leniency applied when parsing semantic version strings.
SemanticVersionFormatValues Exposes all computed version format values used by custom format strings in GitVersion configuration.
SemanticVersionPreReleaseTag Represents the pre-release label and optional numeric identifier of a semantic version (e.g. beta.1).
SemanticVersionWithTag Pairs a parsed SemanticVersion with the ITag it was extracted from.
ServiceCollectionExtensions Extension methods on Microsoft.Extensions.DependencyInjection.IServiceCollection and System.IServiceProvider for GitVersion module registration.
ServiceMessageEscapeHelper Escapes special characters in values written to TeamCity service messages.
Settings Controls general runtime behaviours such as caching, fetching, and branch normalisation.
StringExtensions Extension methods on string and System.Text.StringBuilder for common string manipulations.
Verbosity Represents verbosity.
VersionCalculationModule Registers the version-calculation services including version strategies, variable provider, deployment-mode calculators, and increment strategy finder.
VersionField Identifies the position in a semantic version string that should be incremented.
VersionStrategies A bitmask that enables or disables individual version-discovery strategies.
VersionStrategyModule Registers the built-in IVersionStrategy implementations.
WarningException Raised to report a recoverable warning condition that should be presented to the user rather than treated as a hard error.
WixInfo Controls WiX installer version file update behaviour.

Interface Types

Interface Summary
IBaseVersion Represents a resolved base version that carries both a semantic version value and a pending increment.
IBaseVersionIncrement Base interface for types that describe a version increment: a source description and the commit that anchors the calculation.
IBranch Represents a Git branch, exposing its tip commit and tracking information.
IBranchCollection Represents the set of all branches in a Git repository.
IBranchConfiguration Represents the version-related configuration for a specific branch or branch pattern.
IBuildAgent Represents a CI/CD build agent integration that GitVersion can write version information to.
ICalculationBranchConfiguration Represents branch settings that affect semantic-version calculation.
ICalculationConfiguration Represents settings that participate in semantic-version calculation.
ICommit Represents a single Git commit.
ICommitCollection Represents an ordered, queryable collection of commits in a Git repository.
ICommitish Marker for objects that can serve as the starting point of a commit graph traversal (a commit or a branch tip).
IConfigurationBuilder Builds an IGitVersionConfiguration instance, optionally merging override values.
IConfigurationFileLocator Locates and validates the GitVersion configuration file on the file system.
IConfigurationProvider Loads and provides the IGitVersionConfiguration for the current repository.
IConsole Provides console I/O operations used by GitVersion's logging infrastructure.
IConverterContext Marker interface for context objects passed to IVersionConverter<T> implementations.
ICurrentBuildAgent Marker interface for the build agent that is active in the current execution context.
IDeploymentModeCalculator Applies a deployment-mode-specific calculation to transform a base semantic version into the final version.
IDisposable<T> An System.IDisposable that also exposes a value of type T.
IEffectiveBranchConfigurationFinder Resolves the set of EffectiveBranchConfiguration instances that apply to a given branch.
IEnvironment Provides access to environment variables in the current process.
IGitPreparer Prepares the Git repository so that GitVersion can calculate the version (fetches, clones, and normalises refs as needed).
IGitRepository Provides read-only access to a Git repository.
IGitRepositoryInfo Provides paths describing the layout of the Git repository on disk.
IGitVersionCacheProvider Persists and retrieves GitVersionVariables from a disk cache to avoid redundant recalculation.
IGitVersionCalculateTool Orchestrates the end-to-end version calculation and returns the resulting version variables.
IGitVersionConfiguration Represents the top-level GitVersion configuration, extending branch-level configuration with global settings.
IGitVersionContextFactory Creates a GitVersionContext for the current repository and branch.
IGitVersionModule Represents a self-contained IoC registration module that adds a cohesive set of services to the DI container.
IIgnoreConfiguration Specifies which commits or time ranges should be excluded from version calculation.
IIncrementStrategyFinder Determines the version-field increment that should be applied based on commit messages and branch context.
IMutatingGitRepository Extends IGitRepository with operations that modify the repository state.
INamedReference Represents any Git object (branch, tag, or ref) that has a canonical reference name.
INextVersionCalculator Orchestrates the full version calculation pipeline and returns the next semantic version.
IObjectId Represents the SHA-1 object identifier of a Git object.
IOutputBranchConfiguration Represents branch settings that affect rendered version output.
IOutputConfiguration Represents settings that affect assembly, build-server, and formatted version output.
IPreventIncrementConfiguration Controls under what circumstances automatic version increments should be suppressed.
IReference Represents a Git reference (branch tip, tag, or symbolic ref).
IReferenceCollection Represents the set of all references in a Git repository.
IRefSpec Represents a Git refspec that maps source references to destination references for a remote operation.
IRefSpecCollection Represents an ordered collection of IRefSpec objects for a remote.
IRemote Represents a configured Git remote.
IRemoteCollection Represents the set of remotes configured for a Git repository.
IRepositoryStore Provides high-level read access to a Git repository, exposing the objects and queries needed for version calculation.
ITag Represents a Git tag (lightweight or annotated).
ITagCollection Represents the set of all tags in a Git repository.
ITreeChanges Represents the set of file paths changed between two tree objects.
IVariableProvider Converts a calculated SemanticVersion into the full set of GitVersionVariables.
IVersionConverter<T> Converts GitVersionVariables to a specific output format (e.g. JSON, environment variables, build-server properties).
IVersionFilter Determines whether a base version or commit should be excluded from version calculation.
IVersionStrategy Implements a strategy for discovering candidate base versions from a specific source (e.g. tags, branch names, merge messages).
IVersionVariableSerializer Serializes and deserializes GitVersionVariables to and from JSON and disk files.