Ensure assemble build shows no hints but we now expose --show-hints to enable it

Author: Mpdreamz

src/Elastic.Documentation/Diagnostics/DiagnosticsCollector.cs

@@ -29,7 +29,7 @@ public class DiagnosticsCollector(IReadOnlyCollection<IDiagnosticsOutput> output
 
 	public ConcurrentBag<string> CrossLinks { get; } = [];
 
-	public bool NoHints { get; init; }
+	public bool NoHints { get; set; }
 
 	public DiagnosticsCollector StartAsync(Cancel ctx)
 	{

src/Elastic.Documentation/Diagnostics/IDiagnosticsCollector.cs

@@ -14,6 +14,8 @@ public interface IDiagnosticsCollector : IAsyncDisposable, IHostedService
 	int Errors { get; }
 	int Hints { get; }
 
+	bool NoHints { get; set; }
+
 	DiagnosticsChannel Channel { get; }
 	ConcurrentBag<string> CrossLinks { get; }
 	HashSet<string> OffendingFiles { get; }

src/services/Elastic.Documentation.Assembler/Building/AssemblerBuildService.cs

@@ -11,7 +11,6 @@
 using Elastic.Documentation.Configuration.Assembler;
 using Elastic.Documentation.Configuration.Navigation;
 using Elastic.Documentation.Diagnostics;
-using Elastic.Documentation.Legacy;
 using Elastic.Documentation.LegacyDocs;
 using Elastic.Documentation.Services;
 using Microsoft.Extensions.Logging;
@@ -27,8 +26,17 @@ ICoreService githubActionsService
 {
 	private readonly ILogger _logger = logFactory.CreateLogger<AssemblerBuildService>();
 
-	public async Task<bool> BuildAll(IDiagnosticsCollector collector, bool? strict, string? environment, bool? metadataOnly, IReadOnlySet<Exporter>? exporters, FileSystem fs, Cancel ctx)
+	public async Task<bool> BuildAll(
+		IDiagnosticsCollector collector,
+		bool? strict, string? environment,
+		bool? metadataOnly,
+		bool? showHints,
+		IReadOnlySet<Exporter>? exporters,
+		FileSystem fs,
+		Cancel ctx
+	)
 	{
+		collector.NoHints = !showHints.GetValueOrDefault(false);
 		strict ??= false;
 		exporters ??= metadataOnly.GetValueOrDefault(false) ? ExportOptions.MetadataOnly : ExportOptions.Default;
 		// ensure we never generate a documentation state for assembler builds

src/services/Elastic.Documentation.Assembler/Indexing/AssemblerIndexService.cs

@@ -133,6 +133,6 @@ public async Task<bool> Index(IDiagnosticsCollector collector,
 
 		var exporters = new HashSet<Exporter> { noSemantic.GetValueOrDefault(false) ? ElasticsearchNoSemantic : Elasticsearch };
 
-		return await BuildAll(collector, strict: false, environment, metadataOnly: true, exporters, fileSystem, ctx);
+		return await BuildAll(collector, strict: false, environment, metadataOnly: true, showHints: false, exporters, fileSystem, ctx);
 	}
 }

src/tooling/Elastic.Documentation.Tooling/DocumentationTooling.cs

@@ -37,10 +37,7 @@ public static TBuilder AddDocumentationToolingDefaults<TBuilder>(this TBuilder b
 				var isHelp = sp.GetRequiredService<CliInvocation>();
 				if (isHelp.IsHelpOrVersion)
 					return new DiagnosticsCollector([]);
-				return new ConsoleDiagnosticsCollector(logFactory, githubActionsService)
-				{
-					NoHints = false
-				};
+				return new ConsoleDiagnosticsCollector(logFactory, githubActionsService);
 			})
 			.AddSingleton(sp =>
 			{

src/tooling/docs-assembler/Cli/RepositoryCommands.cs

@@ -90,7 +90,8 @@ public async Task<int> BuildAll(
 		var fs = new FileSystem();
 		var service = new AssemblerBuildService(logFactory, assemblyConfiguration, configurationContext, githubActionsService);
 		serviceInvoker.AddCommand(service, (strict, environment, metadataOnly, exporters, fs), strict ?? false,
-			static async (s, collector, state, ctx) => await s.BuildAll(collector, state.strict, state.environment, state.metadataOnly, state.exporters, state.fs, ctx)
+			static async (s, collector, state, ctx) =>
+				await s.BuildAll(collector, state.strict, state.environment, state.metadataOnly, false, state.exporters, state.fs, ctx)
 		);
 
 		return await serviceInvoker.InvokeAsync(ctx);

src/tooling/docs-builder/Commands/Assembler/AssemblerCommands.cs

@@ -32,19 +32,21 @@ ICoreService githubActionsService
 	/// <param name="fetchLatest"> If true, fetch the latest commit of the branch instead of the link registry entry ref</param>
 	/// <param name="assumeCloned"> If true, assume the repository folder already exists on disk assume it's cloned already, primarily used for testing</param>
 	/// <param name="metadataOnly"> Only emit documentation metadata to output, ignored if 'exporters' is also set </param>
+	/// <param name="showHints"> Show hints from all documentation sets during assembler build</param>
 	/// <param name="exporters"> Set available exporters:
 	///					html, es, config, links, state, llm, redirect, metadata, none.
 	///					Defaults to (html, config, links, state, redirect) or 'default'.
 	/// </param>
 	/// <param name="serve"> Serve the documentation on port 4000 after succesful build</param>
 	/// <param name="ctx"></param>
 	[Command("")]
-	public async Task<int> CloneAll(
+	public async Task<int> CloneAndBuild(
 		bool? strict = null,
 		string? environment = null,
 		bool? fetchLatest = null,
 		bool? assumeCloned = null,
 		bool? metadataOnly = null,
+		bool? showHints = null,
 		[ExporterParser] IReadOnlySet<Exporter>? exporters = null,
 		bool serve = false,
 		Cancel ctx = default
@@ -59,8 +61,9 @@ static async (s, collector, state, ctx) => await s.CloneAll(collector, state.str
 
 		var buildService = new AssemblerBuildService(logFactory, assemblyConfiguration, configurationContext, githubActionsService);
 		var fs = new FileSystem();
-		serviceInvoker.AddCommand(buildService, (strict, environment, metadataOnly, exporters, fs), strict ?? false,
-			static async (s, collector, state, ctx) => await s.BuildAll(collector, state.strict, state.environment, state.metadataOnly, state.exporters, state.fs, ctx)
+		serviceInvoker.AddCommand(buildService, (strict, environment, metadataOnly, showHints, exporters, fs), strict ?? false,
+			static async (s, collector, state, ctx) =>
+				await s.BuildAll(collector, state.strict, state.environment, state.metadataOnly, state.showHints, state.exporters, state.fs, ctx)
 		);
 		var result = await serviceInvoker.InvokeAsync(ctx);
 
@@ -114,6 +117,7 @@ static async (s, collector, state, ctx) => await s.CloneAll(collector, state.str
 	/// <param name="strict"> Treat warnings as errors and fail the build on warnings</param>
 	/// <param name="environment"> The environment to build</param>
 	/// <param name="metadataOnly"> Only emit documentation metadata to output, ignored if 'exporters' is also set </param>
+	/// <param name="showHints"> Show hints from all documentation sets during assembler build</param>
 	/// <param name="exporters"> Set available exporters:
 	///					html, es, config, links, state, llm, redirect, metadata, none.
 	///					Defaults to (html, config, links, state, redirect) or 'default'.
@@ -124,6 +128,7 @@ public async Task<int> BuildAll(
 		bool? strict = null,
 		string? environment = null,
 		bool? metadataOnly = null,
+		bool? showHints = null,
 		[ExporterParser] IReadOnlySet<Exporter>? exporters = null,
 		Cancel ctx = default
 	)
@@ -132,8 +137,9 @@ public async Task<int> BuildAll(
 
 		var fs = new FileSystem();
 		var service = new AssemblerBuildService(logFactory, assemblyConfiguration, configurationContext, githubActionsService);
-		serviceInvoker.AddCommand(service, (strict, environment, metadataOnly, exporters, fs), strict ?? false,
-			static async (s, collector, state, ctx) => await s.BuildAll(collector, state.strict, state.environment, state.metadataOnly, state.exporters, state.fs, ctx)
+		serviceInvoker.AddCommand(service, (strict, environment, metadataOnly, showHints, exporters, fs), strict ?? false,
+			static async (s, collector, state, ctx) =>
+				await s.BuildAll(collector, state.strict, state.environment, state.metadataOnly, state.showHints, state.exporters, state.fs, ctx)
 		);
 
 		return await serviceInvoker.InvokeAsync(ctx);