Enum Types
| Enum | Summary |
|---|---|
| IncrementStrategy | Specifies which version component should be incremented when creating a release from a branch. |
| OutputType | Specifies the format in which GitVersion outputs version variables. |
|
Semantic |
Controls the leniency applied when parsing semantic version strings. |
| VersionField | Identifies the position in a semantic version string that should be incremented. |
Class Types
| Class | Summary |
|---|---|
| AssemblySettingsInfo | Contains options that control how GitVersion updates assembly version attributes and project files. |
| BugException | Indicates an internal logic error that should never occur in normal usage; represents a bug in GitVersion itself. |
|
Git |
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. |
|
Git |
|
| GitVersionOptions | Top-level options object that aggregates all settings used to configure a GitVersion execution. |
|
Lib |
|
| 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. |
| SemanticVersion | Represents a semantic version with optional pre-release tag and build metadata. |
|
Semantic |
Holds the build metadata attached to a semantic version (commits-since-tag, branch, SHA, commit date, etc.). |
|
Semantic |
Exposes all computed version format values used by custom format strings in GitVersion configuration. |
|
Semantic |
Represents the pre-release label and optional numeric
identifier of a semantic version (e.g.
beta.1).
|
| WarningException | Raised to report a recoverable warning condition that should be presented to the user rather than treated as a hard error. |
Interface Types
| Interface | Summary |
|---|---|
| IConverterContext |
Marker interface for context objects passed to
IVersionConverter<T>
implementations.
|
| 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). |
|
I |
Orchestrates the end-to-end version calculation and returns the resulting version variables. |
|
I |
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. |
|
I |
|
| IRepositoryStore | Provides high-level read access to a Git repository, exposing the objects and queries needed for version calculation. |
|
IVersionConverter |
Converts GitVersionVariables to a
specific output format (e.g. JSON, environment variables,
build-server properties).
|