Skip to content

Align Copilot SDK driver docs with engine.driver#42870

Merged
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-fix-engine-copilot-sdk-driver-doc-pars
Jul 2, 2026
Merged

Align Copilot SDK driver docs with engine.driver#42870
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-fix-engine-copilot-sdk-driver-doc-pars

Conversation

Copilot AI commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

The docs advertised engine.copilot-sdk-driver, but the workflow parser only reads engine.driver. This change removes that drift so the documented Copilot SDK driver configuration matches the compiler’s actual behavior.

  • Reference docs

    • Replaced user-facing engine.copilot-sdk-driver examples and prose with engine.driver in the engine reference.
    • Updated the generated frontmatter reference to show driver instead of the ignored key.
  • Behavior documentation

    • Clarified that, for the Copilot engine, setting engine.driver enables engine.copilot-sdk automatically.
    • Updated glossary/internal syntax guidance to describe engine.driver as the canonical field for custom Copilot SDK drivers.
  • Code comments

    • Removed a misleading validation comment that claimed engine.copilot-sdk-driver was still accepted for backward compatibility.
engine:
  id: copilot
  driver: .github/drivers/my_driver.ts
  model: gpt-5

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix doc/parser drift for engine.copilot-sdk-driver Align Copilot SDK driver docs with engine.driver Jul 2, 2026
Copilot AI requested a review from pelikhan July 2, 2026 01:32
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Hey @Copilot 👋 — thanks for cleaning up the drift between the documented engine.copilot-sdk-driver alias and the canonical engine.driver field! Keeping the reference docs, frontmatter reference, glossary, and internal syntax guidance all consistent with what the compiler actually reads is a solid improvement.

One small flag from the checklist:

  • No test file changespkg/workflow/engine_validation.go was touched (a comment was removed). No behavior changed, so a new test isn't strictly necessary, but it's worth confirming that any existing tests for validateEngineDriver still pass cleanly after the comment removal and that nothing references the old copilot-sdk-driver backward-compat note in test assertions.

If you'd like a quick verification pass, you can assign this to your coding agent:

Verify that the existing tests covering `validateEngineDriver` in `pkg/workflow/engine_validation.go` still pass after the removal of the backward-compatibility comment for `engine.copilot-sdk-driver`. Search the test suite for any assertion or fixture that references `copilot-sdk-driver` and confirm none remain. Run the relevant Go test package and report results.

Generated by ✅ Contribution Check · 302.1 AIC · ⌖ 26.3 AIC · ⊞ 6.3K ·

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

🤖 PR Triage — Run §28572743533

Field Value
Category docs
Risk 🟢 Low
Score 40 / 100
Breakdown Impact: 15 · Urgency: 10 · Quality: 15
Action fast_track

Small doc alignment (16+/18−, 5 files). Fixes engine.driver references in docs and syntax — high signal-to-noise, fast to review.

Generated by 🔧 PR Triage Agent · 64.3 AIC · ⌖ 9.84 AIC · ⊞ 1.6K ·

@pelikhan pelikhan marked this pull request as ready for review July 2, 2026 11:52
Copilot AI review requested due to automatic review settings July 2, 2026 11:52
@pelikhan pelikhan merged commit c6ebab4 into main Jul 2, 2026
40 checks passed
@pelikhan pelikhan deleted the copilot/deep-report-fix-engine-copilot-sdk-driver-doc-pars branch July 2, 2026 11:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.driver and clarifies that engine.driver on the Copilot engine enables engine.copilot-sdk automatically.
  • Updates glossary/syntax guidance to describe engine.driver as the canonical driver field.
  • Removes a misleading code comment suggesting engine.copilot-sdk-driver is 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`).
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.82.2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[deep-report] [quick-win] Fix engine.copilot-sdk-driver doc/parser drift

3 participants