Replace logging own implementation with withMicrosoft Extensions Logging by arturcic · Pull Request #4806 · GitTools/GitVersion

arturcic · 2026-01-28T20:19:06Z

This pull request introduces a major overhaul of the logging system, replacing the custom ILog abstraction with the industry-standard Microsoft.Extensions.Logging (M.E.L.) infrastructure, using Serilog as the underlying provider. It removes the legacy logging types, updates dependency injection and usage throughout the codebase, and ensures logging configuration is handled consistently at application startup. Several test and helper classes have also been updated or removed to align with the new logging approach.

Logging System Replacement and Refactoring:

The custom ILog logging system and related types (ILog, ILogAppender, LogLevel, etc.) have been removed and replaced with Microsoft.Extensions.Logging and Serilog. Consumers now use ILogger<T> and related abstractions. [1] [2] F61fee1bL18R18, [3]
Logging configuration is now handled centrally at application startup via the new LoggingEnricher.Configure method, which sets up log file paths, verbosity, and console output based on command-line arguments. [1] [2] [3]
All usages of the old logging system in classes such as GitVersionApp, GitVersionExecutor, and test fixtures have been updated to use dependency-injected ILogger<T> instances. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Dependency and Project File Updates:

Added Microsoft.Extensions.Logging, Microsoft.Extensions.Logging.Abstractions, and Serilog-related packages to the project dependencies, and updated using statements and project references accordingly. [1] F61fee1bL18R18, [2] [3]

Test and Helper Cleanup:

Removed or replaced test helpers and fixtures that relied on the old logging abstractions, such as TestLogAppender, and updated test setup to use the new logging system. [1] [2] [3] [4]

Documentation:

Added a section to BREAKING_CHANGES.md detailing the migration steps and impact of the logging system replacement for custom integrations and extensions.

Minor Test Adjustments:

Updated test assertions and logging output checks to align with the new logging format and behavior.

These changes modernize the logging infrastructure, improve extensibility and maintainability, and bring the codebase in line with .NET ecosystem best practices.

Move IConsole interface and ConsoleAdapter implementation from GitVersion.Logging namespace to the GitVersion namespace under a new Console folder for better organization.

Add new logging enrichers and extensions for Serilog integration: - LoggingEnricher: controls log level and file output path dynamically - SensitiveDataEnricher: masks passwords in URLs using GeneratedRegex - LoggerExtensions: provides BeginTimedOperation and LogSeparator methods The SensitiveDataEnricher replaces the external Serilog.Enrichers.Sensitive package to avoid assembly loading issues in MSBuild task context.

Add TestLogger<T>, TestLoggerFactory, and FactoryLogger<T> to support capturing log messages in unit tests when using ILogger<T> instead of the legacy ILog interface.

Add Serilog packages to support the new logging system: - Serilog - Serilog.Extensions.Logging - Serilog.Sinks.Console - Serilog.Sinks.File - Serilog.Sinks.Map - Microsoft.Extensions.Logging.Abstractions Remove Serilog.Enrichers.Sensitive which caused MSBuild assembly loading issues.

Add AddGitVersionLogging extension method to configure Serilog with: - Console output (conditionally enabled) - File output (dynamically configured via LoggingEnricher) - SensitiveDataEnricher for URL password masking - LoggingEnricher for verbosity control Update GitVersionCommonModule to use the new logging system.