Align Copilot SDK driver docs with engine.driver#42870
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
engine.driver
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Hey One small flag from the checklist:
If you'd like a quick verification pass, you can assign this to your coding agent:
|
🤖 PR Triage — Run §28572743533
|
There was a problem hiding this comment.
Pull request overview
Aligns the documentation and internal guidance for configuring custom Copilot SDK drivers with the compiler’s canonical engine.driver field (instead of the previously documented engine.copilot-sdk-driver), reducing drift between docs and actual parsing/validation behavior.
Changes:
- Updates Copilot SDK configuration docs to use
engine.driverand clarifies thatengine.driveron the Copilot engine enablesengine.copilot-sdkautomatically. - Updates glossary/syntax guidance to describe
engine.driveras the canonical driver field. - Removes a misleading code comment suggesting
engine.copilot-sdk-driveris still accepted.
Show a summary per file
| File | Description |
|---|---|
| pkg/workflow/engine_validation.go | Updates the validation comment to describe only engine.driver. |
| docs/src/content/docs/reference/glossary.md | Updates Copilot SDK and engine.driver glossary entries to reference engine.driver. |
| docs/src/content/docs/reference/frontmatter-full.md | Updates the generated frontmatter reference from copilot-sdk-driver to driver. |
| docs/src/content/docs/reference/engines.md | Updates Copilot SDK support section examples/prose to use engine.driver. |
| .github/aw/syntax-agentic.md | Updates internal syntax guidance to describe Copilot SDK driver configuration via engine.driver. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 5/5 changed files
- Comments generated: 3
- Review effort level: Low
| `engine.driver` must be a **relative path from the workspace root** | ||
| (no absolute paths, `..`, backslashes, or shell metacharacters). It supports: | ||
|
|
| ### Engine Driver (`engine.driver`) | ||
|
|
||
| A Pi engine configuration field that replaces the built-in `pi` CLI with a Node.js driver script. When set, `gh aw` launches the driver with Node.js instead of the `pi` CLI; the driver must emit JSONL compatible with the existing log parser so step summaries and token tracking work unchanged. A bare filename (e.g. `pi_agent_core_driver.cjs`) resolves from the gh-aw setup-action directory; a path containing `/` resolves workspace-relative. | ||
| An engine configuration field that replaces the built-in runtime entrypoint for engines that support driver mode. For the Pi engine, `gh aw` launches the driver with Node.js instead of the `pi` CLI; the driver must emit JSONL compatible with the existing log parser so step summaries and token tracking work unchanged. For the Copilot engine, setting `engine.driver` replaces the built-in SDK driver and enables `engine.copilot-sdk` automatically. A bare filename (e.g. `pi_agent_core_driver.cjs`) resolves from the gh-aw setup-action directory; a path containing `/` resolves workspace-relative. |
| # Custom inner driver script for engines that support driver mode (e.g. pi). | ||
| # Accepts a workspace-relative path ending with .js, .cjs, or .mjs (e.g. | ||
| # `.github/drivers/pi_agent_core_driver_sample_node.cjs`), or a bare filename | ||
| # without a path separator resolved from the gh-aw setup-action directory (e.g. | ||
| # `pi_agent_core_driver.cjs`). |
|
🎉 This pull request is included in a new release. Release: |
The docs advertised
engine.copilot-sdk-driver, but the workflow parser only readsengine.driver. This change removes that drift so the documented Copilot SDK driver configuration matches the compiler’s actual behavior.Reference docs
engine.copilot-sdk-driverexamples and prose withengine.driverin the engine reference.driverinstead of the ignored key.Behavior documentation
engine.driverenablesengine.copilot-sdkautomatically.engine.driveras the canonical field for custom Copilot SDK drivers.Code comments
engine.copilot-sdk-driverwas still accepted for backward compatibility.