Uh oh!
There was an error while loading. Please reload this page.
Align Copilot SDK driver docs with engine.driver - #42870
Merged
pelikhan merged 2 commits intoJul 2, 2026
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Fix doc/parser drift for engine.copilot-sdk-driverAlign Copilot SDK driver docs with Jul 2, 2026
engine.driver
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Contributor
Hey One small flag from the checklist:
If you'd like a quick verification pass, you can assign this to your coding agent:
|
Contributor
🤖 PR Triage — Run §28572743533
|
pelikhan
marked this pull request as ready for review
July 2, 2026 11:52
Uh oh!
There was an error while loading. Please reload this page.
pelikhan
deleted the
copilot/deep-report-fix-engine-copilot-sdk-driver-doc-pars
branch
July 2, 2026 11:53
Contributor
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
Comment on lines
+336
to
338
| `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. |
Comment on lines
+2323
to
+2327
| # 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`). |
Contributor
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.