Skip to content

docs: GitHub Copilot example and test guide - #11

Closed
LutzLange wants to merge 3 commits into
copilot/pr5-reconcile-tickfrom
copilot/pr6-copilot-guide
Closed

LutzLange wants to merge 3 commits into
copilot/pr5-reconcile-tickfrom
copilot/pr6-copilot-guide

Conversation

@LutzLange

Copy link
Copy Markdown
Owner

Stacked on this fork so the diff is this PR only (base: copilot/pr5-reconcile-tick). Tenth and last change in the series; it is the test guide the definition of done asks for, so other people can run the Copilot programs and see what each does.

What it adds. examples/copilot/, following examples/standalone/:

  • compose.yaml: Dex and Agentgateway OSS 1.4.1 (the gateway restarts until Dex answers).
  • agentgateway.yaml: the gateway's own models (llm, Dex-authenticated) and the copilot-proxy pass-through route for GitHub's models (Dex-authenticated, the developer's Copilot token restored as the bearer, HTTP/1.1 to GitHub for the WebSocket upgrade).
  • config.yaml: llmGateway with proxyUrl, OIDC via Dex, the loopback proxy, the opt-in reconcile tick, programs.copilot and programs.vscode (own models; GitHub's models as a comment).
  • README.md: a step-by-step guide with what to check at each step: gateway, sign-in, Copilot CLI, VS Code on own models, VS Code on GitHub's models, drift, conflicts, proxy gone, removal, the controller variant, clean-up, known limits.
  • github-side.md: what the GitHub organisation or enterprise owner sets (plan, BYOK policy, model policy, default models, egress, observability).
    The repository README links it from the proxy section.

How it was checked. An independent agent followed the guide alone in a Linux VM from a clean user account: steps 1-4 and 6 pass with the OSS gateway (PONG from the Copilot CLI and from VS Code on own models with the Dex user in the gateway log, files at 600 with sidecars, a request without the pairing refused, drift, conflict with blocked for the others, proxy gone, removal). Step 5 (GitHub's models) was run earlier against Solo Enterprise for AgentGateway with the same route; with the OSS image the route validates but was not run end to end, and the guide says so. A maintainer-fit review checked every command, port, path, key and log string against the code (every config.yaml key parses, agentgateway.yaml validates on the image); its two majors (the OSS claim, macOS) and the lab's ten gaps (retry after up -d, foreground daemon, login over ssh, a clean account, clean-up and more) are in the second commit; a delta check passed.

Series check on this head. Agent 297, core 22, controller 18, storybook 52; the whole Docker suite 11 of 11.

🤖 Generated with Claude Code

LutzLange and others added 3 commits September 30, 2026 15:46
`examples/copilot` runs Dex and Agentgateway (OSS 1.4.1) with Compose and
an Agentdesktop daemon configuration for the Copilot CLI and VS Code
Copilot Chat:
- `agentgateway.yaml`: the gateway's own models (`llm`, Dex-authenticated)
  and the `copilot-proxy` pass-through route for GitHub's models
  (Dex-authenticated, the developer's Copilot token restored as the bearer,
  HTTP/1.1 to GitHub for the WebSocket upgrade);
- `config.yaml`: `llmGateway` with `proxyUrl`, OIDC via Dex, the loopback
  proxy, the opt-in reconcile tick, `programs.copilot` and `programs.vscode`
  (own models, with the GitHub's-models variant as a comment);
- `README.md`: a step-by-step test guide (start, sign in, Copilot CLI,
  VS Code on own models, VS Code on GitHub's models, drift, conflicts,
  proxy gone, removal, the controller variant, known limits);
- `github-side.md`: what the GitHub organisation or enterprise owner sets
  (plan, BYOK policy, model policy, default models, egress, observability).

The repository README links it from the proxy section.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A lab run followed the guide alone in a VM (steps 1-4 and 6 pass with the
OSS gateway; step 5 not run in that session) and a maintainer review found
gaps a reader without the lab would hit:
- Linux only in the prerequisites (macOS and Windows unit-tested only); the
  login callback port 51327; sign-in and seat needs as run; a clean account
  (a daemon that ran before is undone through its sidecars).
- Step 1: the gateway restarts until Dex answers; retry the check.
- Step 2: foreground daemon, second terminal, Ctrl+C; why no `--dry-run`;
  `daemon.user: true` instead of `--user`; the login without a local browser
  or over ssh; what `status` prints.
- Step 5: run against Solo Enterprise for AgentGateway; with the OSS image
  the route is accepted but not yet run end to end; changing the plan host
  takes two edits and a gateway restart.
- Step 6: start each item from step 4's config; drift brings back the
  managed entries only; the conflict also shows `blocked` for the others.
- New step 9: clean up.
- github-side.md: reader-facing wording; what the gateway sees without a
  controller.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@LutzLange

Copy link
Copy Markdown
Owner Author

Superseded: landed upstream in agentdesktop-dev#146 (examples/copilot guide).

@LutzLange LutzLange closed this Oct 20, 2026
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.

1 participant