[docs] Update aspire update docs: CLI version preflight check for guest AppHost projects#1013
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
When aspire update targets a non-C# (guest) AppHost and the selected SDK is newer than the running CLI, the command now prompts the user to update the CLI first and skips the project update until they do. Documents changes from microsoft/aspire#17100. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the aspire update CLI command reference to document the new preflight behavior when updating guest (non-C#) AppHost projects (for example, TypeScript AppHosts), where the CLI may prompt for a self-update before proceeding to avoid breaking the project.
Changes:
- Added a new “Updating guest (non-C#) AppHost projects” section describing the CLI version preflight check and resulting behavior.
- Documented the user-facing prompt/message and the need to re-run
aspire updateafter updating the CLI. - Added a tip (Aside) recommending
aspire update --selfas a proactive step.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#17100 by
@sebastienros.Targeting
release/13.4based on the source PR milestone13.4.Why this PR is needed
PR microsoft/aspire#17100 changed the behavior of
aspire updatefor guest (non-C#) AppHost projects such as TypeScript AppHosts. When the target Aspire SDK version is newer than the running Aspire CLI, the command now prompts the user to update the CLI before proceeding with the project update. This prevents the project from being left in a broken state when the bundled code generator does not support the selected SDK version.The existing
aspire updatecommand reference had no mention of this guest AppHost preflight behavior or the new user-visible prompts and messages.What was changed
Updated
src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx:UpdateCliBeforeGuestProjectUpdatePromptandProjectUpdateSkippedAfterCliUpdateMessage), and the guidance to re-runaspire updateafter updating the CLI.Asidetip pointing users toaspire update --selfas a proactive alternative.Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx(updated)