Skip to content

docs: Document extension framework debugging, env propagation, and error handling#6860

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/update-extension-framework-docs
Draft

docs: Document extension framework debugging, env propagation, and error handling#6860
Copilot wants to merge 2 commits intomainfrom
copilot/update-extension-framework-docs

Conversation

Copy link
Contributor

Copilot AI commented Feb 24, 2026

extension-framework.md was missing documentation for several shipped features identified as pain points in real-world extension development (#6853).

Changes

  • Debugging Extensions — New section covering:

    • AZD_EXT_DEBUG / AZD_EXT_TIMEOUT for lifecycle/listen extensions
    • azdext.WaitForDebugger(ctx, azdClient) for custom extension commands; documents ErrDebuggerAborted and context.Canceled return values
  • Invoking Extension Commands — Replaces vague "additional env vars are set" with precise behavior split by execution path:

    • Custom commands inherit full os.Environ() + AZD_SERVER, AZD_ACCESS_TOKEN, TRACEPARENT/TRACESTATE, FORCE_COLOR, COLUMNS
    • Lifecycle/listen commands receive only the explicitly set vars above; global flags (--debug, --no-prompt, --cwd, -e) are not forwarded as env vars
    • Reference table for AZD_EXT_DEBUG and AZD_EXT_TIMEOUT with defaults
  • EnvironmentServiceGetValues, GetValue, SetValue: env_name/name is optional; omitting it resolves to the current/default environment (shipped in Make env_name optional in EnvironmentService gRPC methods #6733, undocumented until now)

  • Structured Error Handling — New section on azdext.ServiceError, and clarifying that WrapError/UnwrapError are internal; extension authors return *azdext.ServiceError from provider methods and Azure SDK azcore.ResponseError values are auto-detected

  • Table of Contents — Updated to surface the new sections


💡 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.

… EnvironmentService

Co-authored-by: kristenwomack <5034778+kristenwomack@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for new features in extension framework docs: Update extension framework documentation for debugging, environment propagation, and error handling Feb 24, 2026
Copilot AI requested a review from kristenwomack February 24, 2026 02:08
Copilot AI changed the title docs: Update extension framework documentation for debugging, environment propagation, and error handling docs: Document extension framework debugging, env propagation, and error handling Feb 24, 2026
@kristenwomack kristenwomack linked an issue Feb 24, 2026 that may be closed by this pull request
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update extension framework docs

2 participants