Replace custom ILog implementation with Microsoft.Extensions.Logging and Serilog

src/Directory.Packages.props

@@ -14,7 +14,13 @@
     <PackageVersion Include="Microsoft.CSharp" Version="4.7.0" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.0" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.0" />
     <PackageVersion Include="Microsoft.IO.Redist" Version="6.1.3" />
+    <PackageVersion Include="Serilog" Version="4.2.0" />
+    <PackageVersion Include="Serilog.Extensions.Logging" Version="9.0.0" />
+    <PackageVersion Include="Serilog.Sinks.Console" Version="6.0.0" />
+    <PackageVersion Include="Serilog.Sinks.File" Version="6.0.0" />
     <PackageVersion Include="Polly" Version="8.6.4" />
     <PackageVersion Include="Roslynator.Analyzers" Version="4.14.1" />
     <PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.14.1" />

src/GitVersion.App/CliHost.cs

@@ -1,35 +1,64 @@
+using System.IO.Abstractions;
+using GitVersion;
 using GitVersion.Agents;
 using GitVersion.Configuration;
 using GitVersion.Extensions;
+using GitVersion.Logging;
 using GitVersion.Output;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
+using Serilog;
 
 namespace GitVersion;
 
 internal static class CliHost
 {
     internal static HostApplicationBuilder CreateCliHostBuilder(string[] args)
     {
+        // Parse arguments early to configure logging
+        var tempServices = new ServiceCollection();
+        tempServices.AddSingleton<IArgumentParser, ArgumentParser>();
+        var tempProvider = tempServices.BuildServiceProvider();
+        var argumentParser = tempProvider.GetRequiredService<IArgumentParser>();
+        var arguments = argumentParser.ParseArguments(args);
+        var gitVersionOptions = arguments.ToOptions();
+
         var builder = Host.CreateApplicationBuilder(args);
 
+        // Configure Serilog based on parsed arguments
+        ConfigureSerilog(builder, gitVersionOptions);
+
         builder.Services.AddModule(new GitVersionCoreModule());
         builder.Services.AddModule(new GitVersionLibGit2SharpModule());
         builder.Services.AddModule(new GitVersionBuildAgentsModule());
         builder.Services.AddModule(new GitVersionConfigurationModule());
         builder.Services.AddModule(new GitVersionOutputModule());
         builder.Services.AddModule(new GitVersionAppModule());
 
-        builder.Services.AddSingleton(sp =>
-        {
-            var arguments = sp.GetRequiredService<IArgumentParser>().ParseArguments(args);
-            var gitVersionOptions = arguments.ToOptions();
-            return Options.Create(gitVersionOptions);
-        });
+        builder.Services.AddSingleton(sp => Options.Create(gitVersionOptions));
 
         builder.Services.AddSingleton<GitVersionApp>();
 
         return builder;
     }
+
+    private static void ConfigureSerilog(HostApplicationBuilder builder, GitVersionOptions options)
+    {
+        var loggerConfiguration = LoggingModule.CreateLoggerConfiguration(
+            options.Verbosity,
+            options.Output.Contains(OutputType.BuildServer) || options.LogFilePath == "console",
+            options.LogFilePath != null && options.LogFilePath != "console" ? options.LogFilePath : null,
+            new FileSystem()
+        );
+
+        Serilog.Log.Logger = loggerConfiguration.CreateLogger();
+
+        builder.Services.AddLogging(loggingBuilder =>
+        {
+            loggingBuilder.ClearProviders();
+            loggingBuilder.AddSerilog(Serilog.Log.Logger, dispose: true);
+        });
+    }
 }

src/GitVersion.App/GitVersion.App.csproj

@@ -20,6 +20,7 @@
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" />
         <PackageReference Include="Microsoft.Extensions.Hosting" />
         <PackageReference Include="Microsoft.Extensions.FileSystemGlobbing" />
+        <PackageReference Include="Microsoft.Extensions.Logging" />
     </ItemGroup>
 
     <ItemGroup>

src/GitVersion.Configuration/ConfigurationFileLocator.cs

@@ -1,14 +1,14 @@
 using System.IO.Abstractions;
 using GitVersion.Extensions;
 using GitVersion.Helpers;
-using GitVersion.Logging;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 
 namespace GitVersion.Configuration;
 
 internal class ConfigurationFileLocator(
     IFileSystem fileSystem,
-    ILog log,
+    ILogger<ConfigurationFileLocator> logger,
     IOptions<GitVersionOptions> options)
     : IConfigurationFileLocator
 {
@@ -26,7 +26,7 @@ internal class ConfigurationFileLocator(
     ];
 
     private readonly IFileSystem fileSystem = fileSystem.NotNull();
-    private readonly ILog log = log.NotNull();
+    private readonly ILogger<ConfigurationFileLocator> logger = log.NotNull();
     private readonly IOptions<GitVersionOptions> options = options.NotNull();
 
     private string? ConfigurationFile => options.Value.ConfigurationInfo.ConfigurationFile;
@@ -43,7 +43,7 @@ public void Verify(string? workingDirectory, string? projectRootDirectory)
         var customConfigurationFile = GetCustomConfigurationFilePathIfEligable(directoryPath);
         if (!string.IsNullOrWhiteSpace(customConfigurationFile))
         {
-            this.log.Info($"Found configuration file at '{customConfigurationFile}'");
+            this.logger.LogInformation($"Found configuration file at '{customConfigurationFile}'");
             return customConfigurationFile;
         }
 
@@ -55,10 +55,10 @@ public void Verify(string? workingDirectory, string? projectRootDirectory)
         var files = fileSystem.Directory.GetFiles(directoryPath);
         foreach (var fileName in this.SupportedConfigFileNames)
         {
-            this.log.Debug($"Trying to find configuration file {fileName} at '{directoryPath}'");
+            this.logger.LogDebug($"Trying to find configuration file {fileName} at '{directoryPath}'");
             var matchingFile = files.FirstOrDefault(file => string.Equals(FileSystemHelper.Path.GetFileName(file), fileName, StringComparison.OrdinalIgnoreCase));
             if (matchingFile == null) continue;
-            this.log.Info($"Found configuration file at '{matchingFile}'");
+            this.logger.LogInformation($"Found configuration file at '{matchingFile}'");
             return matchingFile;
         }
 

src/GitVersion.Configuration/ConfigurationProvider.cs

@@ -1,7 +1,7 @@
 using System.IO.Abstractions;
 using GitVersion.Configuration.Workflows;
 using GitVersion.Extensions;
-using GitVersion.Logging;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using YamlDotNet.Core;
 
@@ -10,14 +10,14 @@ namespace GitVersion.Configuration;
 internal class ConfigurationProvider(
     IConfigurationFileLocator configFileLocator,
     IFileSystem fileSystem,
-    ILog log,
+    ILogger<ConfigurationProvider> logger,
     IConfigurationSerializer configurationSerializer,
     IOptions<GitVersionOptions> options)
     : IConfigurationProvider
 {
     private readonly IConfigurationFileLocator configFileLocator = configFileLocator.NotNull();
     private readonly IFileSystem fileSystem = fileSystem.NotNull();
-    private readonly ILog log = log.NotNull();
+    private readonly ILogger<ConfigurationProvider> logger = log.NotNull();
     private readonly IConfigurationSerializer configurationSerializer = configurationSerializer.NotNull();
     private readonly IOptions<GitVersionOptions> options = options.NotNull();
 
@@ -77,17 +77,17 @@ private IGitVersionConfiguration ProvideConfiguration(string? configFile,
     {
         if (configFilePath == null)
         {
-            this.log.Info("No configuration file found, using default configuration");
+            this.logger.LogInformation("No configuration file found, using default configuration");
             return null;
         }
 
         if (!this.fileSystem.File.Exists(configFilePath))
         {
-            this.log.Info($"Configuration file '{configFilePath}' not found");
+            this.logger.LogInformation($"Configuration file '{configFilePath}' not found");
             return null;
         }
 
-        this.log.Info($"Using configuration file '{configFilePath}'");
+        this.logger.LogInformation($"Using configuration file '{configFilePath}'");
         var content = fileSystem.File.ReadAllText(configFilePath);
         return configurationSerializer.Deserialize<Dictionary<object, object?>>(content);
     }

src/GitVersion.Core/Core/BranchesContainingCommitFinder.cs

@@ -1,13 +1,14 @@
 using GitVersion.Common;
 using GitVersion.Extensions;
 using GitVersion.Git;
+using Microsoft.Extensions.Logging;
 using GitVersion.Logging;
 
 namespace GitVersion;
 
-internal class BranchesContainingCommitFinder(IRepositoryStore repositoryStore, ILog log)
+internal class BranchesContainingCommitFinder(IRepositoryStore repositoryStore, ILogger<BranchesContainingCommitFinder> logger)
 {
-    private readonly ILog log = log.NotNull();
+    private readonly ILogger<BranchesContainingCommitFinder> logger = log.NotNull();
     private readonly IRepositoryStore repositoryStore = repositoryStore.NotNull();
 
     public IEnumerable<IBranch> GetBranchesContainingCommit(ICommit commit, IEnumerable<IBranch>? branches = null, bool onlyTrackedBranches = false)
@@ -23,16 +24,16 @@
 
     private IEnumerable<IBranch> InnerGetBranchesContainingCommit(ICommit commit, IEnumerable<IBranch> branches, bool onlyTrackedBranches)
     {
-        using (log.IndentLog($"Getting branches containing the commit '{commit.Id}'."))
+        using (logger.IndentLog($"Getting branches containing the commit '{commit.Id}'."))
         {
             var directBranchHasBeenFound = false;
-            log.Info("Trying to find direct branches.");
+            logger.LogInformation("Trying to find direct branches.");
             // TODO: It looks wasteful looping through the branches twice. Can't these loops be merged somehow? @asbjornu
             var branchList = branches.ToList();
             foreach (var branch in branchList.Where(branch => BranchTipIsNullOrCommit(branch, commit) && !IncludeTrackedBranches(branch, onlyTrackedBranches)))
             {
                 directBranchHasBeenFound = true;
-                log.Info($"Direct branch found: '{branch}'.");
+                logger.LogInformation($"Direct branch found: '{branch}'.");
                 yield return branch;
             }
 
@@ -41,20 +42,20 @@
                 yield break;
             }
 
-            log.Info($"No direct branches found, searching through {(onlyTrackedBranches ? "tracked" : "all")} branches.");
+            logger.LogInformation($"No direct branches found, searching through {(onlyTrackedBranches ? "tracked" : "all")} branches.");
             foreach (var branch in branchList.Where(b => IncludeTrackedBranches(b, onlyTrackedBranches)))
             {
-                log.Info($"Searching for commits reachable from '{branch}'.");
+                logger.LogInformation($"Searching for commits reachable from '{branch}'.");
 
                 var commits = this.repositoryStore.GetCommitsReacheableFrom(commit, branch);
 
                 if (!commits.Any())
                 {
-                    log.Info($"The branch '{branch}' has no matching commits.");
+                    logger.LogInformation($"The branch '{branch}' has no matching commits.");
                     continue;
                 }
 
-                log.Info($"The branch '{branch}' has a matching commit.");
+                logger.LogInformation($"The branch '{branch}' has a matching commit.");
                 yield return branch;
             }
         }