Repository navigation
[docs] Document AddCSharpApp obsoletion in favor of AddDotnetProject - #1853
Draft
aspire-repo-bot[bot] wants to merge 1 commit into
Draft
aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Documents the breaking change from microsoft/aspire#20825: AddCSharpApp (and the polyglot addCSharpApp export) is now marked [Obsolete] instead of [Experimental("ASPIRECSHARPAPPS001")], producing CS0618 instead of the experimental diagnostic. Adds migration guidance pointing consumers to AddDotnetProject from the Aspire.Hosting.Dotnet package. - Added a breaking-change entry to What's new in Aspire 17.0 - Added a Migrating to AddDotnetProject section to the C# file-based apps integration page, with updated Aside/limitations text - Updated the ASPIRECSHARPAPPS001 diagnostic page and the diagnostics overview table to note the obsoletion - Cross-referenced the migration guidance from the .NET host page, project-resources comparison, and the existing-app onboarding guide Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
4 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
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#20825
@mitchdennyTarget branch
Targeting
release/17.0based on the source PR milestone17.0(exact_match).Why this PR is needed
PR #20825 replaces the experimental
ASPIRECSHARPAPPS001diagnostic onAddCSharpApp(and the polyglotaddCSharpAppexport) with a warning-level[Obsolete]attribute directing consumers toAddDotnetProjectfromAspire.Hosting.Dotnet. This is a labeledbreaking-change: existing C#AddCSharpAppcalls now produceCS0618instead of the experimental diagnostic, and the docs site previously describedAddCSharpAppas purely experimental with no obsoletion/migration guidance.Triggered signals from the automated analysis:
obsolete_attribute_added(new[Obsolete(...)]on the public/internalAddCSharpAppoverloads inProjectResourceBuilderExtensions.cs),integration_readme_changed(Aspire.Hosting.Dotnet/README.mdgained a "Migrating from AddCSharpApp" section),pr_label_breaking_change, and PR-body signals confirming a deprecation marker and a "User-facing usage" section.Summary of documentation changes
whats-new/aspire-17.mdx— added a#### AddCSharpApp is obsoleteentry under Breaking changes, explaining the[Obsolete]/CS0618change and linking to the source PR and migration guidance.integrations/dotnet/csharp-file-based-apps.mdx— changed the topAsidebanner from "Experimental" to "Obsolete", updated the limitations list, and added a new## Migrating to AddDotnetProjectsection with install/usage snippets for both C# and TypeScript, plus aCS0618suppression example for consumers who keep usingAddCSharpApp.diagnostics/aspirecsharpapps001.mdx— added a note that the diagnostic is obsolete starting in 17.0 and now surfaces asCS0618, with a link to the new migration section.diagnostics/overview.mdx— updated theASPIRECSHARPAPPS001table row description to mention theCS0618replacement.integrations/frameworks/dotnet/dotnet-host.mdx— added a note pointing readers migrating fromAddCSharpAppto the new migration section.integrations/dotnet/project-resources.mdx— added a note to the "AddProject vs. AddCSharpApp" comparison section flagging the obsoletion.get-started/add-aspire-existing-app.mdx— updated theAddCSharpApp is experimentalcaution callout toAddCSharpApp is obsolete, recommendingAddDotnetProjectfor new AppHosts.All pages were existing — no new pages were created.
Files modified
src/frontend/src/content/docs/whats-new/aspire-17.mdxsrc/frontend/src/content/docs/integrations/dotnet/csharp-file-based-apps.mdxsrc/frontend/src/content/docs/diagnostics/aspirecsharpapps001.mdxsrc/frontend/src/content/docs/diagnostics/overview.mdxsrc/frontend/src/content/docs/integrations/frameworks/dotnet/dotnet-host.mdxsrc/frontend/src/content/docs/integrations/dotnet/project-resources.mdxsrc/frontend/src/content/docs/get-started/add-aspire-existing-app.mdxValidation
Documentation-only change; no code to build or test. Verified internal anchor links (
#migrating-to-adddotnetproject,#breaking-changes) resolve to the headings added in this PR, and checked:::Aside/note fence balance in each edited file.