Skip to content

[docs] Self-healing documentation fix: byok-copilot COPILOT_MODEL default - 2026-04-20 #27352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Apr 20, 2026
+9 −2
Merged

[docs] Self-healing documentation fix: byok-copilot COPILOT_MODEL default - 2026-04-20 #27352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/src/content/docs/reference/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,15 +440,22 @@ Debug workflow using script mode for custom actions.

#### Copilot BYOK Mode (`features.byok-copilot`)

Enables Copilot offline Bring Your Own Key (BYOK) mode with a single flag, bundling three required behaviors: injecting a dummy `COPILOT_API_KEY` to trigger the AWF BYOK runtime path, implicitly enabling `cli-proxy`, and forcing the Copilot CLI to install at `latest` (ignoring any pinned `engine.version`).
Enables Copilot offline Bring Your Own Key (BYOK) mode with a single flag, bundling four required behaviors:

1. Injecting a dummy `COPILOT_API_KEY` to trigger the AWF BYOK runtime path.
2. Implicitly enabling `cli-proxy`.
3. Forcing the Copilot CLI to install at `latest` (ignoring any pinned `engine.version`).
4. Setting `COPILOT_MODEL` to `${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }}` — Copilot BYOK providers require a non-empty model, so the compiler provides `claude-sonnet-4.6` as the fallback when `GH_AW_MODEL_AGENT_COPILOT` is not set.

```yaml wrap
engine: copilot
features:
byok-copilot: true
```

Without this flag, BYOK mode requires manual composition of all three behaviors. With `byok-copilot: true`, the compiler handles the wiring automatically.
Without this flag, BYOK mode requires manual composition of all four behaviors. With `byok-copilot: true`, the compiler handles the wiring automatically.

To use a different model, set the `GH_AW_MODEL_AGENT_COPILOT` repository variable. The compiled workflow uses `${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'claude-sonnet-4.6' }}` for `COPILOT_MODEL`.

> [!IMPORTANT]
> `byok-copilot` is a gh-aw convenience extension point, not an enforcement boundary. gh-aw does not enforce Copilot BYOK usage.
Expand Down
Loading