Document AppHost path config guardrails#862
Merged
Merged
Conversation
Clarify that appHost.path is a local project-scoped setting, global AppHost paths are ignored, and legacy appHostPath cannot be set with aspire config set. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
adamint
commented
May 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Aspire CLI configuration documentation to describe appHost.path as the supported local AppHost path setting, clarifies that AppHost paths are not configurable via global settings (and are ignored with a warning if present), and notes that the legacy appHostPath key is blocked by aspire config set.
Changes:
- Updates the config settings table to document
appHost.path(instead of legacyappHostPath). - Adds a dedicated “Configure the AppHost path” section explaining local-only behavior and legacy key handling.
- Adds guardrail notes to the config file description include and the
aspire config setcommand reference.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md | Updates documented config keys to appHost.path and adjusts descriptions accordingly. |
| src/frontend/src/content/docs/reference/cli/includes/config-file-description.md | Adds a note that appHost.path must be configured locally. |
| src/frontend/src/content/docs/reference/cli/configuration.mdx | Adds an AppHost path configuration section and updates examples/references to appHost.path. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-config-set.mdx | Clarifies that project-specific settings like appHost.path aren’t global-settable. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
adamint
commented
May 6, 2026
Use AppHost entry point terminology and a script entry point example so the docs do not imply appHost.path must reference a project file. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
appHost.pathas the supported local AppHost path setting.appHostPathkey is blocked byaspire config set.Addresses item 8 in #837.
Validation
pnpm --dir ./src/frontend run lintpnpm --dir ./src/frontend run test:unit:docs