Summary
- Total Breaking Changes: 2
- Severity: HIGH
- Commits Analyzed: 1 (
1b2e3b2)
- Status: ⚠️ Requires Immediate Review
Critical Breaking Changes
Two breaking schema changes were detected in the commit from the last 24 hours. Both are documented as major changesets.
| Commit |
File |
Category |
Change |
Impact |
1b2e3b2 |
pkg/parser/schemas/main_workflow_schema.json |
Schema Change |
imports.if field removed — conditional imports no longer accepted |
Workflows using imports: - uses: ... if: ... will fail validation |
1b2e3b2 |
pkg/parser/schemas/main_workflow_schema.json |
Schema Change (Field Rename) |
app: field renamed to github-app: |
Workflows with top-level or nested app: auth blocks will fail validation |
Full Code Diff Analysis
Breaking Change 1: Remove imports.if support
Changeset: .changeset/major-remove-imports-if.md
Category: Schema Change — Removing fields from workflow frontmatter schema
Evidence: The main_workflow_schema.json diff shows the imports array item object no longer includes an if property. The changeset confirms this is intentional.
User Impact: Any workflow frontmatter that uses if: inside an imports: entry will now fail schema validation at compile time.
Migration: Remove if: keys from imports: entries. For conditional fragment inclusion, move the condition into the workflow body using {{#if experiments.<name>}} and {{#runtime-import ...}}.
Breaking Change 2: Rename app: field to github-app:
Changeset: .changeset/minor-rename-app-to-github-app.md (declared as major)
Category: Schema Change — Field Rename (schema breaking per policy: renaming fields requires a major version bump)
Evidence: The main_workflow_schema.json diff shows github-app: fields added throughout; the corresponding app: key is absent from the new schema.
User Impact: Workflows using top-level app: or nested app: auth blocks will fail validation.
Migration: Replace app: with github-app: in all workflow frontmatter. An automated codemod is available: run gh aw fix.
All Commits Analyzed
Commit 1b2e3b2 — feat(no-json-stringify-error): scope-aware suggestions + detail-preserving second suggestion (#43748)
- Date: 2026-07-06
- Author: Copilot
- This is the sole commit in the repository (initial commit, all files are new additions).
- Contains 2 major changesets documenting breaking changes to schema fields.
- CLI-relevant files changed:
cmd/gh-aw/main.go, pkg/cli/ (full package), pkg/parser/schemas/ (4 schema files).
Action Checklist
Complete the following items to address these breaking changes:
Recommendations
- Schema rename (
app: → github-app:): Run gh aw fix to apply the provided codemod to existing workflows before upgrading.
- Conditional imports removal: Audit all workflows for
imports: entries with if: conditions and migrate to {{#runtime-import}} inside {{#if}} blocks.
- Version bump: Both changes are marked
major — the next release must be a major version bump.
- CHANGELOG.md: Add "Breaking Changes" section entries for both changes so users are informed at upgrade time.
Reference
See scratchpad/breaking-cli-rules.md for the complete breaking change policy.
Once all checklist items are complete, close this issue.
⚠️ Compatibility report by Breaking Change Checker · 51.4 AIC · ⌖ 12.1 AIC · ⊞ 5.3K · ◷
Summary
1b2e3b2)Critical Breaking Changes
Two breaking schema changes were detected in the commit from the last 24 hours. Both are documented as
majorchangesets.1b2e3b2pkg/parser/schemas/main_workflow_schema.jsonimports.iffield removed — conditional imports no longer acceptedimports: - uses: ... if: ...will fail validation1b2e3b2pkg/parser/schemas/main_workflow_schema.jsonapp:field renamed togithub-app:app:auth blocks will fail validationFull Code Diff Analysis
Breaking Change 1: Remove
imports.ifsupportChangeset:
.changeset/major-remove-imports-if.mdCategory: Schema Change — Removing fields from workflow frontmatter schema
Evidence: The
main_workflow_schema.jsondiff shows theimportsarray item object no longer includes anifproperty. The changeset confirms this is intentional.User Impact: Any workflow frontmatter that uses
if:inside animports:entry will now fail schema validation at compile time.Migration: Remove
if:keys fromimports:entries. For conditional fragment inclusion, move the condition into the workflow body using{{#if experiments.<name>}}and{{#runtime-import ...}}.Breaking Change 2: Rename
app:field togithub-app:Changeset:
.changeset/minor-rename-app-to-github-app.md(declared asmajor)Category: Schema Change — Field Rename (schema breaking per policy: renaming fields requires a major version bump)
Evidence: The
main_workflow_schema.jsondiff showsgithub-app:fields added throughout; the correspondingapp:key is absent from the new schema.User Impact: Workflows using top-level
app:or nestedapp:auth blocks will fail validation.Migration: Replace
app:withgithub-app:in all workflow frontmatter. An automated codemod is available: rungh aw fix.All Commits Analyzed
Commit
1b2e3b2—feat(no-json-stringify-error): scope-aware suggestions + detail-preserving second suggestion (#43748)cmd/gh-aw/main.go,pkg/cli/(full package),pkg/parser/schemas/(4 schema files).Action Checklist
Complete the following items to address these breaking changes:
.changeset/directory — Both changesets (major-remove-imports-if.md,minor-rename-app-to-github-app.md) already exist and specifymajorbump type ✅app:→github-app:rename)Recommendations
app:→github-app:): Rungh aw fixto apply the provided codemod to existing workflows before upgrading.imports:entries withif:conditions and migrate to{{#runtime-import}}inside{{#if}}blocks.major— the next release must be a major version bump.Reference
See scratchpad/breaking-cli-rules.md for the complete breaking change policy.
Once all checklist items are complete, close this issue.