You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Schema change: The engine object in pkg/parser/schemas/main_workflow_schema.json has additionalProperties: false
Removed property: copilot-sdk-driver was removed from the allowed engine properties list
Added property: driver replaces it as the canonical field name
Runtime backward compat: pkg/workflow/engine.go still parses copilot-sdk-driver and maps it to the internal Driver field — workflows still execute correctly
But schema validation fails: Since additionalProperties: false, gh aw compile will reject workflows with engine.copilot-sdk-driver via JSON schema validation error
Codemod available: gh aw fix --write auto-migrates engine.copilot-sdk-driver → engine.driver via pkg/cli/codemod_engine_driver.go
Changeset: .changeset/minor-pi-agent-core-driver.md — tagged minor, but per breaking CLI rules this is a major change (schema field removal with additionalProperties: false)
Breaking Change Patterns Detected
Schema Field Removal (Category: Schema Changes)
Decision tree:
Is it removing schema fields or making optional fields required?
├─ YES → BREAKING ✓
From pkg/parser/schemas/main_workflow_schema.json engine_config object:
additionalProperties: false is enforced
copilot-sdk-driver is absent from current properties list: ['id', 'version', 'model', 'model-provider', ..., 'driver']
fix(cache-memory): ensure detection on safe outputs
✅ Bug fix
Others
Docs, community, lock file updates, infra fixes
✅ Not CLI-related
Notable non-breaking concern — PR #40822: Renames 3 flags without deprecation warnings. Per the breaking change policy, deprecated flags should print a warning to stderr. The MarkHidden() approach preserves backward compatibility but violates deprecation guidelines. No changeset was added for these flag renames.
Action Checklist
Complete the following items to address these breaking changes:
Review all breaking changes detected — Verify that copilot-sdk-driver schema removal is correctly categorized as breaking (schema enforces additionalProperties: false)
Create a changeset file in .changeset/ directory — Update .changeset/minor-pi-agent-core-driver.md bump type from minor → major, or create a new major-remove-copilot-sdk-driver-schema.md. Specify major in the YAML frontmatter. See scratchpad/changesets.md for format details.
Add migration guidance to changeset — Include: "Replace engine.copilot-sdk-driver: <path> with engine.driver: <path>, or run gh aw fix --write to auto-migrate."
Document breaking changes in CHANGELOG.md — Add entry under "Breaking Changes": engine.copilot-sdk-driver removed from schema; engine.driver is the canonical field name
Verify backward compatibility was considered — Runtime parse still works; gh aw fix --write codemod migrates automatically
Immediate: Upgrade .changeset/minor-pi-agent-core-driver.md bump type from minor to major to correctly signal the breaking schema change per scratchpad/breaking-cli-rules.md.
Migration: Users with engine.copilot-sdk-driver in workflows must run gh aw fix --write before the next release to avoid compile failures.
Consider: Adding a parse-time deprecation warning (stderr) when copilot-sdk-driver is encountered, to help users discover affected workflows before release.
Summary
Critical Breaking Changes
pkg/parser/schemas/main_workflow_schema.jsoncopilot-sdk-driverproperty fromengineobjectgh aw compilefails for workflows usingengine.copilot-sdk-driver; schema enforcesadditionalProperties: falseFull Code Diff Analysis
Detailed Commit Analysis
PR #40897: Add shared
engine.driverfield with@earendil-works/pi-agent-corebuilt-in driverengineobject inpkg/parser/schemas/main_workflow_schema.jsonhasadditionalProperties: falsecopilot-sdk-driverwas removed from the allowed engine properties listdriverreplaces it as the canonical field namepkg/workflow/engine.gostill parsescopilot-sdk-driverand maps it to the internalDriverfield — workflows still execute correctlyadditionalProperties: false,gh aw compilewill reject workflows withengine.copilot-sdk-drivervia JSON schema validation errorgh aw fix --writeauto-migratesengine.copilot-sdk-driver→engine.driverviapkg/cli/codemod_engine_driver.go.changeset/minor-pi-agent-core-driver.md— taggedminor, but per breaking CLI rules this is a major change (schema field removal withadditionalProperties: false)Breaking Change Patterns Detected
Schema Field Removal (Category: Schema Changes)
Decision tree:
From
pkg/parser/schemas/main_workflow_schema.jsonengine_config object:additionalProperties: falseis enforcedcopilot-sdk-driveris absent from currentpropertieslist:['id', 'version', 'model', 'model-provider', ..., 'driver']All Commits Analyzed
PRs Analyzed (last 24 hours)
engine.driverfieldmodel-providerselectionengine.llm-providersilently ignored (no schema impact)platform.typeviasandbox.agent.platform--skip-secret,--disable-security-scanner,--disable-release-bumpto--no-*Notable non-breaking concern — PR #40822: Renames 3 flags without deprecation warnings. Per the breaking change policy, deprecated flags should print a warning to stderr. The
MarkHidden()approach preserves backward compatibility but violates deprecation guidelines. No changeset was added for these flag renames.Action Checklist
Complete the following items to address these breaking changes:
copilot-sdk-driverschema removal is correctly categorized as breaking (schema enforcesadditionalProperties: false).changeset/directory — Update.changeset/minor-pi-agent-core-driver.mdbump type fromminor→major, or create a newmajor-remove-copilot-sdk-driver-schema.md. Specifymajorin the YAML frontmatter. See scratchpad/changesets.md for format details.engine.copilot-sdk-driver: <path>withengine.driver: <path>, or rungh aw fix --writeto auto-migrate."engine.copilot-sdk-driverremoved from schema;engine.driveris the canonical field namegh aw fix --writecodemod migrates automaticallyMarkHidden()withMarkDeprecated()for--disable-security-scanner,--skip-secret,--disable-release-bumpso users receive stderr warnings per policyRecommendations
.changeset/minor-pi-agent-core-driver.mdbump type fromminortomajorto correctly signal the breaking schema change per scratchpad/breaking-cli-rules.md.engine.copilot-sdk-driverin workflows must rungh aw fix --writebefore the next release to avoid compile failures.copilot-sdk-driveris encountered, to help users discover affected workflows before release.cobra Flags().MarkHidden()withFlags().MarkDeprecated()so scripts using old flag names see clear migration guidance.Reference
See scratchpad/breaking-cli-rules.md for the complete breaking change policy.
Once all checklist items are complete, close this issue.
References: