[docs] Clarify C# file-based AppHost launch profile location#1176
Draft
aspire-repo-bot[bot] wants to merge 1 commit into
Draft
[docs] Clarify C# file-based AppHost launch profile location#1176aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
The empty C# AppHost template (created with `aspire new`) stores launch profiles in `apphost.run.json`, not in `aspire.config.json`. The `aspire.config.json` for this template only contains the `appHost.path` reference pointing at `apphost.cs`. Update the AppHost configuration page to distinguish between: - Project-based AppHosts: profiles in `Properties/launchSettings.json` - File-based AppHosts: profiles in `apphost.run.json`, with `aspire.config.json` holding only the entry-point reference This aligns the documentation with the fix in microsoft/aspire#17781, which corrected a regression where the file-based template was incorrectly emitting a duplicate `profiles` block in `aspire.config.json`. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
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#17781 by
@mitchdenny.Targeting
release/13.4— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.5(from the source PR milestone13.5) does not exist there.Why this PR is needed
PR microsoft/aspire#17781 fixed a regression introduced in the 13.4 cycle where the empty C# AppHost template (
aspire new) was incorrectly emitting a duplicateprofilesblock inaspire.config.json. Launch profiles for the file-based C# AppHost belong exclusively inapphost.run.json;aspire.config.jsonshould only contain{"appHost": {"path": "apphost.cs"}}.The existing
app-host/configuration.mdxpage stated "In C# AppHosts, profiles live inlaunchSettings.json" without distinguishing between project-based and file-based AppHosts. This omission could lead users to look for profiles in the wrong file when working with the file-based (single-file) template.Changes
Updated
src/frontend/src/content/docs/app-host/configuration.mdxto:dotnet new aspire-apphost): profiles inProperties/launchSettings.jsonaspire newempty C# template): profiles inapphost.run.json, whileaspire.config.jsononly holds theappHost.pathreferenceapphost.run.jsonandaspire.config.jsonstructure for file-based AppHostsaspire run,dotnet run apphost.cs, and C# Dev Kit all readapphost.run.jsonfor launch profiles when it is presentFiles modified
src/frontend/src/content/docs/app-host/configuration.mdx— updated existing page