[build] Enhance docs-fetch command

Author: AndreyAkinshin

.github/workflows/generate-changelog.yaml

@@ -20,7 +20,7 @@ jobs:
         ref: master
 
     - name: Fetch changelog
-      run: ./build.cmd docs-fetch --depth 1 --preview
+      run: ./build.cmd docs-fetch --depth 1 --preview --force-clone
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -32,4 +32,4 @@ jobs:
         FOLDER: docs/_changelog
         GIT_CONFIG_NAME: Andrey Akinshin
         GIT_CONFIG_EMAIL: [email protected]
-        CLEAN: true
+        CLEAN: true

build/BenchmarkDotNet.Build/Options/KnownOptions.cs

@@ -29,6 +29,12 @@ public static class KnownOptions
         Aliases = new[] { "-d" }
     };
 
+    public static readonly BoolOption ForceClone = new("--force-clone")
+    {
+        Description = "Forces re-cloning of the changelog repository, deleting any existing directory.",
+        Aliases = new[] { "-f" }
+    };
+
     public static readonly BoolOption Help = new("--help")
     {
         Description = "Prints help information",

build/BenchmarkDotNet.Build/Program.cs

@@ -172,13 +172,14 @@ public HelpInfo GetHelp()
                           $"* Last changelog footer (if {KnownOptions.Stable.CommandLineName} is specified)\n" +
                           $"* All changelog details in docs/_changelog\n" +
                           $"  (This dir is a cloned version of this repo from branch {Repo.ChangelogBranch})",
-            Options = [KnownOptions.DocsPreview, KnownOptions.DocsDepth],
+            Options = [KnownOptions.DocsPreview, KnownOptions.DocsDepth, KnownOptions.ForceClone],
             EnvironmentVariables = [EnvVar.GitHubToken],
             Examples =
             [
                 new Example(Name)
                     .WithArgument(KnownOptions.DocsDepth, "3")
                     .WithArgument(KnownOptions.DocsPreview)
+                    .WithArgument(KnownOptions.ForceClone)
             ]
         };
     }

build/BenchmarkDotNet.Build/Runners/Changelog/ChangelogBuilder.cs

@@ -17,6 +17,7 @@ public class ChangelogBuilder
     private readonly BuildContext context;
     private readonly bool preview;
     private readonly string depth;
+    private readonly bool forceClone;
 
     /// <summary>
     /// Directory with original changelog part files from branch 'docs-changelog'
@@ -33,6 +34,7 @@ public ChangelogBuilder(BuildContext context)
         this.context = context;
         preview = KnownOptions.DocsPreview.Resolve(context);
         depth = KnownOptions.DocsDepth.Resolve(context);
+        forceClone = KnownOptions.ForceClone.Resolve(context);
 
         var docsDirectory = context.RootDirectory.Combine("docs");
         SrcDirectory = docsDirectory.Combine("_changelog");
@@ -43,7 +45,7 @@ public void Fetch()
     {
         EnvVar.GitHubToken.AssertHasValue();
 
-        EnsureSrcDirectoryExist();
+        EnsureSrcDirectoryExist(forceClone);
 
         var history = context.VersionHistory;
         var stableVersionCount = history.StableVersions.Length;
@@ -224,14 +226,31 @@ private void GenerateToc()
         context.GenerateFile(DocfxDirectory.CombineWithFilePath("toc.yml"), content);
     }
 
-    private void EnsureSrcDirectoryExist(bool forceClean = false)
+    private void EnsureSrcDirectoryExist(bool forceClone = false)
     {
-        if (context.DirectoryExists(SrcDirectory) && forceClean)
+        void Log(string message) => context.Information($"[Changelog] {message}");
+
+        Log($"Preparing git sub-repository for changelog branch '{Repo.ChangelogBranch}'. " +
+            $"Target directory: '{SrcDirectory}'.");
+        if (context.DirectoryExists(SrcDirectory) && forceClone)
+        {
+            Log($"Directory '{SrcDirectory}' already exists and forceClean is specified. " +
+                $"Deleting the current directory...");
             context.DeleteDirectory(
                 SrcDirectory,
                 new DeleteDirectorySettings { Force = true, Recursive = true });
+            Log($"Directory '{SrcDirectory}' deleted successfully.");
+        }
 
         if (!context.DirectoryExists(SrcDirectory))
+        {
+            Log($"Cloning branch '{Repo.ChangelogBranch}' from '{Repo.HttpsGitUrl}' to '{SrcDirectory}'.");
             context.GitRunner.Clone(SrcDirectory, Repo.HttpsGitUrl, Repo.ChangelogBranch);
+            Log($"Clone completed: '{Repo.ChangelogBranch}' -> '{SrcDirectory}'.");
+        }
+        else
+        {
+            Log($"Directory '{SrcDirectory}' already exists. Skipping clone.");
+        }
     }
 }