Skip to content

[breaking-change] Daily Breaking Change Analysis - 2026-07-01 #42793

Description

@github-actions

Summary

  • Total Breaking Changes: 6
  • Severity: HIGH
  • Commits Analyzed: 1 (dfc4ad5)
  • Status: Review Recommended

Critical Breaking Changes

The following breaking changes are present as pending unreleased changesets in the codebase committed in the last 24 hours. All have existing changeset files documenting the migration path, but action items below should be verified.

Commit File Category Change Impact
dfc4ad5 pkg/parser/schemas/main_workflow_schema.json Schema Change imports.if conditional field removed from imports entries Workflows using conditional imports will fail validation
dfc4ad5 pkg/parser/schemas/main_workflow_schema.json Schema Change Top-level app: field renamed to github-app: Workflows using app: will fail validation
dfc4ad5 pkg/parser/schemas/main_workflow_schema.json Schema Change Top-level sandbox: false removed; replaced with sandbox.agent: false Workflows using sandbox: false will break
dfc4ad5 Engine config Flag/Field Rename supportsLLMGateway renamed to llmGatewayPort (now mandatory) Engine configs using supportsLLMGateway: true must migrate
dfc4ad5 Behavior Behavior Change Status comment no longer enabled by default alongside ai-reaction emoji Workflows relying on implicit status comments need status-comment: true
dfc4ad5 MCP config Behavior Change MCP Gateway v0.1.5 stricter validation (Docker-only stdio, explicit mount modes, no mounts on HTTP servers) Previously-valid MCP configs may be rejected
Full Code Diff Analysis

Detailed Commit Analysis

Commit dfc4ad5 — "Audit: attach experiment/variant provenance to report records (#42735)"

This is the sole commit in the analysis window (the repository initial commit). The PR itself adds non-breaking experiment_name and variant optional JSON fields (with omitempty) to audit report structs (MissingToolReport, NoopReport, MissingDataReport, MCPFailureReport in pkg/cli/logs_models.go). These are additive changes and are not breaking.

However, the commit bundles 6 pending changeset files, each declaring "gh-aw": major, documenting breaking changes already present in the codebase.

Breaking Change Patterns Detected

  1. Schema field removal (imports.if): The imports: array entries no longer accept an if condition. Violates the rule: "Removing fields from workflow frontmatter schema".

  2. Schema field rename (app:github-app:): A top-level workflow frontmatter field was renamed. Violates: "Renaming a command without an alias" (applied to schema fields).

  3. Schema field restructure (sandbox: falsesandbox.agent: false): A boolean top-level option was replaced by a nested object key. Violates: "Changing the type of a field" and "Removing fields from workflow frontmatter schema".

  4. Engine config rename + mandatory (supportsLLMGatewayllmGatewayPort): Field renamed and changed from optional to required. Violates: "Changing a flag name without backward compatibility" and "Making optional fields required".

  5. Default behavior change (status comment): Implicit status comment opt-out changes default behavior users rely on. Violates: "Changing default values for flags".

  6. Validation strictness (MCP Gateway v0.1.5): Previously-valid configs now rejected. Violates: "Making strict mode validation refuse instead of warn".

All Commits Analyzed
SHA Message Date
dfc4ad5 Audit: attach experiment/variant provenance to report records (#42735) 2026-07-01

Changeset files present in commit (major bumps):

  • .changeset/major-remove-imports-if.md
  • .changeset/minor-decouple-status-comment.md ("gh-aw": major)
  • .changeset/minor-disable-agent-sandbox-only.md ("gh-aw": major)
  • .changeset/minor-rename-app-to-github-app.md ("gh-aw": major)
  • .changeset/minor-rename-llmgateway-port.md ("gh-aw": major)
  • .changeset/minor-update-mcpg-v0-1-5.md ("gh-aw": major)

Action Checklist

Complete the following items to address these breaking changes:

  • Review all breaking changes detected — Six breaking changes identified and categorized above
  • Create a changeset file in .changeset/ directory — All 6 breaking changes have existing changeset files with "gh-aw": major declared
  • Add migration guidance to changeset — Verify each changeset file contains complete migration instructions (most already do; verify minor-update-mcpg-v0-1-5.md examples are sufficient)
  • Document breaking changes in CHANGELOG.md — Add entries under "Breaking Changes" section for all 6 changes with user-facing descriptions
  • Verify backward compatibility was considered — Confirm gh aw fix codemod support exists for app:github-app: and sandbox: falsesandbox.agent: false migrations (per changeset docs)

Recommendations

  • Version bump: All 6 changesets declare major; the next release must be a major version bump.
  • Migration tooling: The gh aw fix codemod should cover app:github-app: and sandbox: falsesandbox.agent: false. Verify codemod correctness before release.
  • Status comment change: Consider adding a deprecation warning for the implicit status-comment behavior in a prior minor release before the default changes, to reduce user surprise.
  • MCP Gateway: Provide a validation command (gh aw validate or similar) so users can pre-check their MCP configs before upgrading to v0.1.5.
  • llmGatewayPort mandate: Since this field is now required (previously optional), ensure engine authors are notified via release notes.

Reference

See scratchpad/breaking-cli-rules.md for the complete breaking change policy.


Once all checklist items are complete, close this issue.

References:

⚠️ Compatibility report by Breaking Change Checker · 44.4 AIC · ⌖ 17.7 AIC · ⊞ 1.6K ·

  • expires on Jul 3, 2026, 7:57 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