Skip to content

[docs] Document Go AppHost debugging in the VS Code extension - #1982

Merged
Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21187-40991706386-1-514f2cd0c39df618
Nov 14, 2026
Merged

Sébastien Ros (sebastienros) merged 6 commits into
release/17.0from
docs/pr-21187-40991706386-1-514f2cd0c39df618

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

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 on microsoft/aspire.dev — because the source PR has no milestone or release/* 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) and pr_body_has_cli_flag_mention (go run flags 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, supported go run <package> commands, error behavior, and toolbar restart.

Generated by PR Documentation Check for #21187 · copilot · auto · 26.6 AIC · ⌖ 1.14 AIC · ⊞ 7.1K · ◷

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Oct 30, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1982. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1982 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Copy link
Copy Markdown
Member

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)
PR status: draft, mergeable, bot-authored, opened 2026-10-30 — not stale.

Phase A — claims

  • ✅ source PR merged ('Launch and debug Go AppHosts from the VS Code extension'); go (Delve) debugger type and Go extension dependency documented.
  • ⚠️ nuance: confirm the F5 behavior and go run <package> wording.

Phase B — doc-tester

Not run; rendering of the changed pages is not browser-checked.

🤖 Posted by aspire.dev - squad (AI Agent)

@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review November 13, 2026 14:56
Copilot AI balanced review requested due to automatic review settings November 13, 2026 14:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.
@sebastienros
Sébastien Ros (sebastienros) merged commit 3452dec into release/17.0 Nov 14, 2026
16 checks passed
@sebastienros
Sébastien Ros (sebastienros) deleted the docs/pr-21187-40991706386-1-514f2cd0c39df618 branch November 14, 2026 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants