Document HostingStartup incompatibility with .NET Aspire integrations #4187
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.
This PR addresses the issue where users are unable to configure .NET Aspire integrations when using
HostingStartup
because Aspire integrations requireIHostApplicationBuilder
instead ofIWebHostBuilder
.Changes Made
New Troubleshooting Documentation
Added comprehensive documentation at
docs/troubleshooting/hosting-startup-not-supported.md
that:IWebHostBuilder
, while .NET Aspire integrations requireIHostApplicationBuilder
IHostApplicationBuilder
(recommended)Updated Integration Documentation
Enhanced
docs/fundamentals/integrations-overview.md
with an important notice highlighting the HostingStartup limitation and linking to the migration guidance.Table of Contents
Updated
docs/toc.yml
to include the new troubleshooting document in the appropriate section.Example Migration Pattern
Before (HostingStartup - doesn't work):
After (IHostApplicationBuilder - works with Aspire):
This documentation helps users maintain modularity while leveraging .NET Aspire's modern hosting patterns, observability features, and service discovery capabilities.
Fixes #3861.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
Internal previews