Add breaking change detection CI check

Adds a new 'major-change-check' job to the PR workflow that detects
potential breaking changes by comparing the branch against main.

TEST: Removed include_config_on_deploy from AppSchema to verify
Zod schema breaking change detection. Revert before merging.

Author: alfonso-noriega

.github/workflows/tests-pr.yml

@@ -287,3 +287,65 @@ jobs:
           header: Type-diff
           message: ${{ steps.type-diff.outputs.report }}
           recreate: true
+
+  major-change-check:
+    if: github.event.pull_request.head.repo.full_name == github.repository
+    name: 'Breaking change detection'
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    outputs:
+      has_breaking_changes: ${{ steps.read-results.outputs.has_breaking_changes }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name || github.event.repository.full_name }}
+          ref: ${{ github.event.pull_request.head.ref || github.event.merge_group.head_ref }}
+          fetch-depth: 1
+      - name: Setup deps
+        uses: ./.github/actions/setup-cli-deps
+        with:
+          node-version: ${{ env.DEFAULT_NODE_VERSION }}
+      - name: Build
+        run: pnpm nx run-many --all --skip-nx-cache --target=build --output-style=stream
+      - name: Check for breaking changes
+        working-directory: workspace
+        run: pnpm nx run major-change-check
+      - name: Read results
+        id: read-results
+        run: |
+          HAS_BREAKING=$(cat workspace/has-breaking-changes)
+          echo "has_breaking_changes=$HAS_BREAKING" >> "$GITHUB_OUTPUT"
+          if [ "$HAS_BREAKING" = "true" ] && [ -f workspace/breaking-changes-report.md ]; then
+            {
+              echo 'report<<BREAKING_CHANGES_EOF'
+              cat workspace/breaking-changes-report.md
+              echo 'BREAKING_CHANGES_EOF'
+            } >> "$GITHUB_OUTPUT"
+          fi
+      - uses: marocchino/sticky-pull-request-comment@fcf6fe9e4a0409cd9316a5011435be0f3327f1e1 # v2.3.1
+        if: steps.read-results.outputs.has_breaking_changes == 'true'
+        with:
+          header: Breaking-change-detection
+          message: ${{ steps.read-results.outputs.report }}
+          recreate: true
+      - uses: marocchino/sticky-pull-request-comment@fcf6fe9e4a0409cd9316a5011435be0f3327f1e1 # v2.3.1
+        if: steps.read-results.outputs.has_breaking_changes != 'true'
+        with:
+          header: Breaking-change-detection
+          delete: true
+      - name: Fail if breaking changes detected
+        if: steps.read-results.outputs.has_breaking_changes == 'true'
+        run: |
+          echo '::error::Breaking changes detected. A member of @shopify/dev_experience must approve the breaking-change-approval environment.'
+          exit 1
+
+  major-change-approval:
+    name: 'Breaking change approval'
+    needs: major-change-check
+    if: always() && needs.major-change-check.outputs.has_breaking_changes == 'true'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    environment: breaking-change-approval
+    steps:
+      - name: Approved
+        run: echo '✅ Breaking changes approved by dev_experience team member'

.gitignore

@@ -206,3 +206,7 @@ packages/cli-kit/src/cli/api/graphql/*/*_schema.graphql
 
 # Local dev alias scripts
 bin/p
+
+# Breaking change check outputs
+workspace/breaking-changes-report.md
+workspace/has-breaking-changes

packages/app/src/cli/models/app/app.ts

@@ -60,7 +60,6 @@ export const AppSchema = zod
       .object({
         automatically_update_urls_on_dev: zod.boolean().optional(),
         dev_store_url: zod.string().optional(),
-        include_config_on_deploy: zod.boolean().optional(),
       })
       .optional(),
     extension_directories: ExtensionDirectoriesSchema,

workspace/project.json

@@ -21,6 +21,14 @@
         "commands": ["node src/type-diff.js"],
         "cwd": "workspace"
       }
+    },
+    "major-change-check": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["^build"],
+      "options": {
+        "commands": ["node src/major-change-check.js"],
+        "cwd": "workspace"
+      }
     }
   }
 }