Add clarification that hosting APIs require framework-dependent deployments #49595
+3
−0
Conversation
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
…oyments Co-authored-by: agocke <515774+agocke@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add clarification on hosting APIs usage in netcore-hosting docs
Add clarification that hosting APIs require framework-dependent deployments
Nov 3, 2025
Copilot finished work on behalf of
agocke
November 3, 2025 20:06
agocke
reviewed
Nov 3, 2025
| Hosting the .NET runtime is done with the `nethost` and `hostfxr` libraries' APIs. These entry points handle the complexity of finding and setting up the runtime for initialization and allow both launching a managed application and calling into a static managed method. | ||
|
|
||
| > [!IMPORTANT] | ||
| > The `nethost` and `hostfxr` hosting APIs only support framework-dependent deployments. These APIs don't work with single-file deployments because the required runtime files must be available separately on the target system. If you're evaluating deployment models for your application, use a framework-dependent deployment to ensure compatibility with these native hosting APIs. |
Member
There was a problem hiding this comment.
Suggested change
| > The `nethost` and `hostfxr` hosting APIs only support framework-dependent deployments. These APIs don't work with single-file deployments because the required runtime files must be available separately on the target system. If you're evaluating deployment models for your application, use a framework-dependent deployment to ensure compatibility with these native hosting APIs. | |
| > The `nethost` and `hostfxr` hosting APIs only support framework-dependent deployments. Self-contained deployments are only supported with the built-in hosts. If you're evaluating deployment models for your application, use a framework-dependent deployment to ensure compatibility with these native hosting APIs. |
@copilot please fix
Contributor
Author
There was a problem hiding this comment.
Updated the note to clarify that self-contained deployments are only supported with built-in hosts. Commit: 9c857e6
Co-authored-by: agocke <515774+agocke@users.noreply.github.com>
Copilot finished work on behalf of
agocke
November 3, 2025 21:56
Clarify deployment model information for nethost and hostfxr APIs.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds an important note to clarify that the nethost and hostfxr hosting APIs only support framework-dependent deployments and don't work with self-contained deployments.
Key Changes
- Added an IMPORTANT callout box explaining hosting API deployment model limitations.
- Provided guidance to use framework-dependent deployments for compatibility with native hosting APIs.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
The
nethostandhostfxrhosting APIs don't support self-contained deployments, but this limitation wasn't documented.Changes
The note appears immediately after the introductory paragraph in the "Hosting APIs" section, ensuring readers understand this constraint before implementing a custom host.
This pull request was created as a result of the following prompt from Copilot chat.
Original prompt
This pull request was created as a result of the following prompt from Copilot chat.
💡 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