Skip to content

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

Description

@github-actions

Description

The docs advertise engine.copilot-sdk-driver as a configurable key (docs/src/content/docs/reference/engines.md:325,332,336 and frontmatter-full.md:2329), but the parser only reads engineObj["driver"] (pkg/workflow/engine.go:409). Grep confirms no parse-time "copilot-sdk-driver" key lookup exists anywhere in pkg/workflow — only a comment in engine_validation.go:117 claims backward-compat. Users copying the documented copilot-sdk-driver: example get a key the compiler ignores.

Fix

Either (a) add copilot-sdk-driver as an explicit parse-time alias for driver, or (b) rewrite the docs/generated examples to use engine.driver only. Option (b) is the smaller, safer change.

Expected Impact

Removes a user-facing config that silently no-ops; docs match parser behavior.

Suggested Agent

Claude Code User Docs Review agent, or Copilot SWE Agent.

Estimated Effort

Fast (< 30 min)

Data Source

Schema Consistency Check #42684; verified on main. DeepReport run https://github.com/github/gh-aw/actions/runs/28528843163

Generated by 🔬 Deep Report · 214.1 AIC · ⌖ 17.7 AIC · ⊞ 10.2K ·

  • expires on Jul 3, 2026, 7:43 AM UTC-08:00

Metadata

Metadata

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions