Skip to content

Clarify Aspire update notification #17366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
DamianEdwards wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Clarify Aspire update notification #17366

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce90abc
Clarify Aspire update notification
DamianEdwards May 21, 2026
1d4b8f5
Gate AppHost update guidance to run context
DamianEdwards May 21, 2026
d9c96ba
Address update banner review feedback
DamianEdwards May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/Aspire.Cli/Commands/BaseCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ internal abstract class BaseCommand : Command
private static readonly int[] s_suppressErrorLogsMessageExitCodes = [CliExitCodes.Cancelled, CliExitCodes.MissingRequiredArgument];

protected virtual bool UpdateNotificationsEnabled { get; } = true;
protected virtual bool IncludeAppHostUpdateCommandInUpdateNotification { get; }

/// <summary>
/// Gets the help group for this command.
Expand Down Expand Up @@ -118,7 +119,7 @@ protected BaseCommand(string name, string description, IFeatures features, ICliU
{
try
{
updateNotifier.NotifyIfUpdateAvailable();
updateNotifier.NotifyIfUpdateAvailable(IncludeAppHostUpdateCommandInUpdateNotification);
}
catch
{
Expand Down
4 changes: 4 additions & 0 deletions src/Aspire.Cli/Commands/RunCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,15 @@ internal sealed class RunCommand : BaseCommand
private readonly ICliHostEnvironment _hostEnvironment;
private readonly ProfilingTelemetry _profilingTelemetry;
private bool _isDetachMode;
private bool _hasAppHostContext;

// Guest AppHosts can bring up the temporary server/backchannel and then fail immediately
// afterward when the guest startup process hits a syntax or pre-execute error. Keep the
// detached parent waiting briefly so those early failures are reported instead of hidden.
private static readonly TimeSpan s_detachedStartupStabilityWindow = TimeSpan.FromSeconds(2);

protected override bool UpdateNotificationsEnabled => !_isDetachMode;
protected override bool IncludeAppHostUpdateCommandInUpdateNotification => _hasAppHostContext;
Copy link
Copy Markdown
Member

@adamint adamint May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also add to StartCommand?

Copy link
Copy Markdown
Member Author

@DamianEdwards DamianEdwards May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this for start too. AppHostLauncher now reports when it has selected an AppHost, so start includes the AppHost guidance only after that context is known.


private static readonly Option<bool> s_detachOption = new("--detach")
{
Expand Down Expand Up @@ -132,6 +134,7 @@ public RunCommand(

protected override async Task<CommandResult> ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken)
{
_hasAppHostContext = false;
var passedAppHostProjectFile = parseResult.GetValue(AppHostLauncher.s_appHostOption);
var detach = parseResult.GetValue(s_detachOption);
_isDetachMode = detach;
Expand Down Expand Up @@ -220,6 +223,7 @@ protected override async Task<CommandResult> ExecuteAsync(ParseResult parseResul
runActivity?.SetTag(TelemetryConstants.Tags.ErrorType, "project_not_found");
return CommandResult.Failure(CliExitCodes.FailedToFindProject);
}
_hasAppHostContext = true;

// Resolve the language for this file and get the appropriate handler
var project = _projectFactory.TryGetProject(effectiveAppHostFile);
Expand Down
9 changes: 7 additions & 2 deletions src/Aspire.Cli/Interaction/ConsoleInteractionService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,15 +693,20 @@ public void DisplayEmptyLine()

private const string UpdateUrl = "https://aka.ms/aspire/update";

public void DisplayVersionUpdateNotification(string newerVersion, string? updateCommand = null)
public void DisplayVersionUpdateNotification(string newerVersion, string? updateCommand = null, bool includeAppHostUpdateCommand = false)
{
// Write to stderr to avoid corrupting stdout when JSON output is used
_errorConsole.WriteLine();
_errorConsole.MarkupLine(string.Format(CultureInfo.CurrentCulture, InteractionServiceStrings.NewCliVersionAvailable, newerVersion.EscapeMarkup()));

if (includeAppHostUpdateCommand)
{
_errorConsole.MarkupLine(string.Format(CultureInfo.CurrentCulture, InteractionServiceStrings.ToUpdateAppHostRunCommand, "aspire update"));
}
Comment on lines +700 to +707
Copy link
Copy Markdown
Member

@JamesNK JamesNK May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will only display if the CLI is out of date. And it will display if the CLI is out of date and the app host is up to date.

Really there should be seperate checks for the CLI version and app host version, and then the correct notifications are displayed based on each result.

Copy link
Copy Markdown
Member Author

@DamianEdwards DamianEdwards May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep ideally they'd be separate checks, but today we always ship them together. Today it won't display if the CLI is up to date but the apphost is not IIUC. I think this is a good incremental improvement though.

Copy link
Copy Markdown
Member

@JamesNK JamesNK May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can get the app host version from the backchannel. It's displayed in aspire ps. We should be able to get it from the app host and compare it with either the installed version of the CLI. Only comparing it with the installed version makes sense because aspire update won't do anything if there is a newer version of the CLI until it is installed.


if (!string.IsNullOrEmpty(updateCommand))
{
_errorConsole.MarkupLine(string.Format(CultureInfo.CurrentCulture, InteractionServiceStrings.ToUpdateRunCommand, updateCommand.EscapeMarkup()));
_errorConsole.MarkupLine(string.Format(CultureInfo.CurrentCulture, InteractionServiceStrings.ToUpdateCliRunCommand, updateCommand.EscapeMarkup()));
}

_errorConsole.MarkupLine(string.Format(CultureInfo.CurrentCulture, InteractionServiceStrings.MoreInfoNewCliVersion, MarkupHelpers.SafeLink(this, UpdateUrl)));
Copy link
Copy Markdown
Member

@adamint adamint May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Append this to the end of "A new version of.."? 4 lines is visually heavy.

Copy link
Copy Markdown
Member Author

@DamianEdwards DamianEdwards May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. The AppHost guidance is now appended to the version line as (use aspire update for this AppHost), so the AppHost case is three lines instead of four.

Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Cli/Interaction/ExtensionInteractionService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,9 +488,9 @@ public void DisplayMarkupLine(string markup)
_consoleInteractionService.DisplayMarkupLine(markup);
}

public void DisplayVersionUpdateNotification(string newerVersion, string? updateCommand = null)
public void DisplayVersionUpdateNotification(string newerVersion, string? updateCommand = null, bool includeAppHostUpdateCommand = false)
{
_consoleInteractionService.DisplayVersionUpdateNotification(newerVersion, updateCommand);
_consoleInteractionService.DisplayVersionUpdateNotification(newerVersion, updateCommand, includeAppHostUpdateCommand);
}

public void DisplayRenderable(IRenderable renderable)
Expand Down
2 changes: 1 addition & 1 deletion src/Aspire.Cli/Interaction/IInteractionService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ internal interface IInteractionService
/// </summary>
bool SupportsLinks { get; }

void DisplayVersionUpdateNotification(string newerVersion, string? updateCommand = null);
void DisplayVersionUpdateNotification(string newerVersion, string? updateCommand = null, bool includeAppHostUpdateCommand = false);
// The semantic type is stringly-typed because some values originate from backchannel payloads.
// Use ConsoleLogTypes for CLI-defined values.
void WriteConsoleLog(string message, int? lineNumber = null, string? type = null, bool isErrorMessage = false);
Expand Down
15 changes: 12 additions & 3 deletions src/Aspire.Cli/Resources/InteractionServiceStrings.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions src/Aspire.Cli/Resources/InteractionServiceStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,12 @@
<value>[dim]For more information, see: {0}[/]</value>
<comment>Do not translate [dim]. Also leave [/] as-is. {0} is a pre-formatted link</comment>
</data>
<data name="ToUpdateRunCommand" xml:space="preserve">
<value>[dim]To update, run: {0}[/]</value>
<data name="ToUpdateAppHostRunCommand" xml:space="preserve">
<value>[dim]To update this AppHost, run: {0}[/]</value>
Copy link
Copy Markdown
Member

@adamint adamint May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<value>[dim]To update this AppHost, run: {0}[/]</value>
<value>[dim]To update this AppHost, use: {0}[/]</value>

Copy link
Copy Markdown
Member Author

@DamianEdwards DamianEdwards May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the AppHost wording to use use instead of
un.

<comment>Do not translate [dim]. Also leave [/] as-is. {0} is the command to run</comment>
</data>
<data name="ToUpdateCliRunCommand" xml:space="preserve">
<value>[dim]To update the Aspire CLI, run: {0}[/]</value>
Copy link
Copy Markdown
Member

@adamint adamint May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<value>[dim]To update the Aspire CLI, run: {0}[/]</value>
<value>[dim]To update the Aspire CLI, use: {0}[/]</value>

Copy link
Copy Markdown
Member Author

@DamianEdwards DamianEdwards May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the CLI wording to use use instead of
un.

<comment>Do not translate [dim]. Also leave [/] as-is. {0} is the command to run</comment>
</data>
<data name="UnbuildableAppHostsDetected" xml:space="preserve">
Expand Down
11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.cs.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.de.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.es.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.fr.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.it.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.ja.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.ko.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.pl.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.pt-BR.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.ru.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.tr.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.zh-Hans.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions src/Aspire.Cli/Resources/xlf/InteractionServiceStrings.zh-Hant.xlf
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading