Repository navigation
[docs] Document Go AppHost debugging in the VS Code extension - #1982
Sébastien Ros (sebastienros) merged 6 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
docs-pr-reviewer report — [partial — phase A: key claims evaluated; phase B: not run (docs site was not served in this automated run)]Recommendation: approve Source used: microsoft/aspire#21187 (merged 2026-10-30) Phase A — claims
Phase B — doc-testerNot run; rendering of the changed pages is not browser-checked. 🤖 Posted by aspire.dev - squad (AI Agent) |
There was a problem hiding this comment.
🟡 Changes recommended
The documentation incorrectly promises an error when the Go extension is missing; it should distinguish normal launches that fall back to the CLI without an AppHost debugger from unsupported delegated commands that produce errors.
1 open issue
What changed in this PR
Documents Go AppHost debugging in the Aspire VS Code extension, covering the support introduced by microsoft/aspire#21187.
Changes:
- Adds Go, the Delve adapter, and the required Go extension to the language coverage table.
- Describes Go AppHost launch and debugging, command restrictions, error behavior, and toolbar restart.
| File | Description |
|---|---|
src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx |
Adds Go debugger coverage and Go AppHost run/debug guidance. |
Review effort: Balanced
| | Azure Functions, C# / .NET | `coreclr` | [Azure Functions](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions) plus [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) | | ||
| | Azure Functions, JavaScript / TypeScript | `js-debug` | None (built into VS Code) | | ||
|
|
||
| Go AppHosts (`apphost.go`) can also be run and debugged from the Aspire view or <Kbd windows='F5' />. The extension runs the CLI's `go run <package>` command through the Go extension's Delve adapter, using the AppHost directory as the program and forwarding the AppHost's own arguments. If the command isn't `go run <package>` (for example, it includes `go run` flags such as `-tags`), or the Go extension isn't installed, the extension shows an error instead of debugging the wrong program. Toolbar restart of a Go AppHost session performs the ordered Aspire restart. |
The unknown-arguments example ran 'aspire destroy --force' in a bash block, which the pipeline command options unit test flags as an undocumented option. Describe the invalid option in prose and keep the error output.

Documents changes from microsoft/aspire#21187 by
@sebastienros's reviewed PR author (see source PR).Target branch: Targeting
release/17.0— the latest release branch onmicrosoft/aspire.dev— because the source PR has no milestone orrelease/*base ref to derive a more specific target.Why: The source PR lets the VS Code extension launch and debug Go AppHosts (
apphost.go) via the Go extension's Delve adapter. Triggered signals:polyglot_code_generator_changed(GoLanguageSupport.cs) andpr_body_has_cli_flag_mention(go runflags in the PR body).Changes (1 page updated):
src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx: added a Go row to the language coverage table and a note on Go AppHost run/debug, supportedgo run <package>commands, error behavior, and toolbar restart.