Fail the build on CI if new cachable SVG files are discovered

Author: Mpdreamz

src/Elastic.Documentation.Configuration/Diagram/DiagramRegistry.cs

@@ -4,6 +4,7 @@
 
 using System.Collections.Concurrent;
 using System.IO.Abstractions;
+using Elastic.Documentation.Diagnostics;
 using Elastic.Documentation.Extensions;
 using Microsoft.Extensions.Logging;
 
@@ -70,6 +71,13 @@ public async Task<int> CreateDiagramCachedFiles(Cancel ctx)
 				if (_readFileSystem.File.Exists(diagramInfo.OutputFile.FullName))
 					return;
 
+				// If we are running on CI, and we are creating cached files we should fail the build and alert the user to create them
+				if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("CI")))
+				{
+					context.Collector.EmitGlobalError($"Discovered new diagram SVG '{localPath}' please run `docs-builder --force` to ensure a cached version is generated");
+					return;
+				}
+
 				// Create the directory if needed
 				var directory = _writeFileSystem.Path.GetDirectoryName(diagramInfo.OutputFile.FullName);
 				if (directory != null && !_writeFileSystem.Directory.Exists(directory))

src/Elastic.Documentation/Diagnostics/IDiagnosticsCollector.cs

@@ -53,5 +53,3 @@ public static void EmitGlobalWarning(this IDiagnosticsCollector collector, strin
 	public static void EmitGlobalHint(this IDiagnosticsCollector collector, string message) =>
 		collector.EmitHint(string.Empty, message);
 }
-
-

src/Elastic.Markdown/DocumentationGenerator.cs

@@ -161,9 +161,7 @@ public async Task CreateDiagramCachedFiles(Cancel ctx)
 	{
 		var downloadedCount = await DocumentationSet.DiagramRegistry.CreateDiagramCachedFiles(ctx);
 		if (downloadedCount > 0)
-		{
 			_logger.LogInformation("Downloaded {DownloadedCount} diagram files from Kroki", downloadedCount);
-		}
 	}
 
 	/// <summary>

src/tooling/docs-builder/Http/DocumentationWebHost.cs

@@ -193,15 +193,12 @@ private static async Task<IResult> ServeDocumentationFile(ReloadableGeneratorSta
 		var generator = holder.Generator;
 		const string navPartialSuffix = ".nav.html";
 
-		// Check if the original request is asking for LLM-rendered markdown
+		// Check if the original request is asking for LLM-rendered Markdown
 		var requestLlmMarkdown = slug.EndsWith(".md");
-		var originalSlug = slug;
 
 		// If requesting .md output, remove the .md extension to find the source file
 		if (requestLlmMarkdown)
-		{
 			slug = slug[..^3]; // Remove ".md" extension
-		}
 
 		if (slug.EndsWith(navPartialSuffix))
 		{
@@ -258,9 +255,7 @@ private static async Task<IResult> ServeDocumentationFile(ReloadableGeneratorSta
 				{
 					var svgPath = Path.Combine(generator.DocumentationSet.OutputDirectory.FullName, slug.TrimStart('/'));
 					if (File.Exists(svgPath))
-					{
 						return Results.File(svgPath, "image/svg+xml");
-					}
 				}
 
 				if (!generator.DocumentationSet.FlatMappedFiles.TryGetValue("404.md", out var notFoundDocumentationFile))