Show --log-level debug hint when pipeline fails (#12603)

* Initial plan

* Add help message when pipeline fails

- Modified ConsoleActivityLogger to accept optional commandName in SetFinalResult
- Display help message when pipeline fails with command name
- Updated PipelineCommandBase to pass command name to logger

Co-authored-by: davidfowl <[email protected]>

* Use boolean field instead of string Contains check

Store the succeeded value from SetFinalResult in _pipelineSucceeded field
and use !_pipelineSucceeded instead of checking if string contains "PIPELINE FAILED"

Co-authored-by: davidfowl <[email protected]>

* Pass command name in ConsoleActivityLogger constructor

Move command name from SetFinalResult parameter to constructor parameter.
This is cleaner since the command name doesn't change throughout the
lifecycle of the logger.

Co-authored-by: davidfowl <[email protected]>

* Make commandName non-nullable in ConsoleActivityLogger

The commandName parameter is always provided from PipelineCommandBase.Name
and should never be null. Changed constructor signature to make it a
required parameter and removed null checks.

Co-authored-by: davidfowl <[email protected]>

* Reorganize fields for better maintainability

Move _finalStatusHeader and _pipelineSucceeded fields to the top with
other private fields for better organization and consistency.

Co-authored-by: davidfowl <[email protected]>

* Update help message and suppress when debug/trace logging enabled

- Changed message to generic "For more details, add --log-level debug/trace to the command."
- Suppress help message when user already passed --log-level debug or trace
- Replaced commandName parameter with isDebugOrTraceLoggingEnabled flag

Co-authored-by: davidfowl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: davidfowl <[email protected]>

Author: Copilot

src/Aspire.Cli/Commands/PipelineCommandBase.cs

@@ -224,11 +224,16 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
             var publishingActivities = backchannel.GetPublishingActivitiesAsync(cancellationToken);
 
             var debugMode = parseResult.GetValue<bool?>("--debug") ?? false;
+            
+            // Check if debug or trace logging is enabled
+            var logLevel = parseResult.GetValue(_logLevelOption);
+            var isDebugOrTraceLoggingEnabled = logLevel?.Equals("debug", StringComparison.OrdinalIgnoreCase) == true ||
+                                                 logLevel?.Equals("trace", StringComparison.OrdinalIgnoreCase) == true;
 
             var noFailuresReported = debugMode switch
             {
                 true => await ProcessPublishingActivitiesDebugAsync(publishingActivities, backchannel, cancellationToken),
-                false => await ProcessAndDisplayPublishingActivitiesAsync(publishingActivities, backchannel, cancellationToken),
+                false => await ProcessAndDisplayPublishingActivitiesAsync(publishingActivities, backchannel, isDebugOrTraceLoggingEnabled, cancellationToken),
             };
 
             // Send terminal progress bar stop sequence
@@ -406,11 +411,11 @@ public async Task<bool> ProcessPublishingActivitiesDebugAsync(IAsyncEnumerable<P
         return !hasErrors;
     }
 
-    public async Task<bool> ProcessAndDisplayPublishingActivitiesAsync(IAsyncEnumerable<PublishingActivity> publishingActivities, IAppHostBackchannel backchannel, CancellationToken cancellationToken)
+    public async Task<bool> ProcessAndDisplayPublishingActivitiesAsync(IAsyncEnumerable<PublishingActivity> publishingActivities, IAppHostBackchannel backchannel, bool isDebugOrTraceLoggingEnabled, CancellationToken cancellationToken)
     {
         var stepCounter = 1;
         var steps = new Dictionary<string, StepInfo>();
-        var logger = new ConsoleActivityLogger(_hostEnvironment);
+        var logger = new ConsoleActivityLogger(_hostEnvironment, isDebugOrTraceLoggingEnabled);
         logger.StartSpinner();
         PublishingActivity? publishingActivity = null;
 

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

@@ -18,6 +18,7 @@ internal sealed class ConsoleActivityLogger
 {
     private readonly bool _enableColor;
     private readonly ICliHostEnvironment _hostEnvironment;
+    private readonly bool _isDebugOrTraceLoggingEnabled;
     private readonly object _lock = new();
     private readonly Stopwatch _stopwatch = Stopwatch.StartNew();
     private readonly Dictionary<string, string> _stepColors = new();
@@ -35,6 +36,9 @@ internal sealed class ConsoleActivityLogger
     private readonly char[] _spinnerChars = ['|', '/', '-', '\\'];
     private int _spinnerIndex;
 
+    private string? _finalStatusHeader;
+    private bool _pipelineSucceeded;
+
     // No raw ANSI escape codes; rely on Spectre.Console markup tokens.
 
     private const string SuccessSymbol = "✓";
@@ -43,10 +47,11 @@ internal sealed class ConsoleActivityLogger
     private const string InProgressSymbol = "→";
     private const string InfoSymbol = "i";
 
-    public ConsoleActivityLogger(ICliHostEnvironment hostEnvironment, bool? forceColor = null)
+    public ConsoleActivityLogger(ICliHostEnvironment hostEnvironment, bool isDebugOrTraceLoggingEnabled = false, bool? forceColor = null)
     {
         _hostEnvironment = hostEnvironment;
         _enableColor = forceColor ?? _hostEnvironment.SupportsAnsi;
+        _isDebugOrTraceLoggingEnabled = isDebugOrTraceLoggingEnabled;
 
         // Disable spinner in non-interactive environments
         if (!_hostEnvironment.SupportsInteractiveOutput)
@@ -252,20 +257,28 @@ public void WriteSummary()
             if (!string.IsNullOrEmpty(_finalStatusHeader))
             {
                 AnsiConsole.MarkupLine(_finalStatusHeader!);
+                
+                // If pipeline failed and not already in debug/trace mode, show help message about using --log-level debug
+                if (!_pipelineSucceeded && !_isDebugOrTraceLoggingEnabled)
+                {
+                    var helpMessage = _enableColor
+                        ? "[dim]For more details, add --log-level debug/trace to the command.[/]"
+                        : "For more details, add --log-level debug/trace to the command.";
+                    AnsiConsole.MarkupLine(helpMessage);
+                }
             }
             AnsiConsole.MarkupLine(line);
             AnsiConsole.WriteLine(); // Ensure final newline after deployment summary
         }
     }
 
-    private string? _finalStatusHeader;
-
     /// <summary>
     /// Sets the final deployment result lines to be displayed in the summary (e.g., DEPLOYMENT FAILED ...).
     /// Optional usage so existing callers remain compatible.
     /// </summary>
     public void SetFinalResult(bool succeeded)
     {
+        _pipelineSucceeded = succeeded;
         // Always show only a single final header line with symbol; no per-step duplication.
         if (succeeded)
         {