chore: Automation to check changes in the peerDependencies (#20213)

Author: rmch91

.github/workflows/ci-continuous-integration.yml

@@ -87,8 +87,80 @@ jobs:
       - name: Run linting validation
         run: |
           ci-scripts/validate-lint.sh
+  check_peer_dependencies:
+    name: CI - Check peerDependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Run peerDependencies check
+        run: |
+          bash ci-scripts/check-peer-deps.sh ${{ github.event.pull_request.base.ref }}
+      - name: Collect peer dependency changes
+        id: collect-peer-deps
+        run: |
+          if [ -s peer-deps-result.txt ]; then
+            echo "output<<EOF" >> $GITHUB_OUTPUT
+            echo "### ❗ peerDependencies changes detected:" >> $GITHUB_OUTPUT
+            cat peer-deps-result.txt >> $GITHUB_OUTPUT
+            echo "EOF" >> $GITHUB_OUTPUT
+          else
+            echo "output=No peerDependencies changes detected" >> $GITHUB_OUTPUT
+          fi
+      - name: Post PR comment if peerDependencies changed
+        if: failure() && github.event.pull_request
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fs = require('fs');
+                const path = 'peer-deps-result.txt';
+
+            if (!fs.existsSync(path)) {
+              console.log("No peer-deps result file found. Skipping comment.");
+              return;
+            }
+
+            const diff = fs.readFileSync(path, 'utf8').trim();
+            if (!diff) {
+              console.log("peer-deps result file is empty. Skipping comment.");
+              return;
+            }
+
+            const issue_number = context.payload.pull_request.number;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const botUser = context.actor;
+
+            const commentHeader = "🚨 **PeerDependencies Change Detected** 🚨";
+
+            const body = `
+              ${commentHeader}
+
+              Your pull request includes modifications to \`peerDependencies\` in the following file(s):
+
+              \`\`\`diff
+              ${diff}
+              \`\`\`
+
+              Please note: Changes to peerDependencies are **restricted** and only permitted during **framework update releases**, as they may introduce breaking changes for customer's applications.
+              If you believe this change is necessary, please reach out to the Asterix team for further assistance.
+              `;
+
+            await github.rest.issues.createComment({
+              issue_number,
+              owner,
+              repo,
+              body
+            });
+
   ci_result:
-    needs: [unit_tests, sonarqube_scan, linting]
+    needs: [unit_tests, sonarqube_scan, linting, check_peer_dependencies]
     name: CI - Result
     runs-on: ubuntu-latest
     if: ${{ always() }}

ci-scripts/check-peer-deps.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# Origin is passed as an argument to the script, defaulting to 'develop' if not provided.
+BASE_BRANCH=${1:-develop}
+
+git fetch origin "$BASE_BRANCH:$BASE_BRANCH"
+
+echo "🔍 Checking for changes in peerDependencies compared to $BASE_BRANCH..."
+
+# Variable holds the list of changed package.json files
+# between the current branch and the base branch.
+changed_files=$(git diff --name-only "$BASE_BRANCH" HEAD -- '**/package.json')
+
+# If no package.json files have changed, exit the script.
+if [ -z "$changed_files" ]; then
+    echo "✅ No package.json files changed."
+    exit 0
+fi
+
+echo "📦 Changed package.json files:"
+echo "$changed_files"
+
+# Create a temporary file to store changed peerDependencies in diff format.
+# This file is used to post PR comment later.
+result_file="peer-deps-result.txt"
+
+failed=0
+
+for file in $changed_files; do
+    echo ""
+    echo "🔧 Checking file: $file"
+
+    # Check if file exists on base branch; skip if it doesn't
+    if ! git ls-tree -r "$BASE_BRANCH" --name-only | grep -qx "$file"; then
+        echo "Skipping new file: $file (doesn't exist on $BASE_BRANCH)"
+        continue
+    fi
+
+    git show "$BASE_BRANCH":"$file" 2>/dev/null | awk '/"peerDependencies": ?{/,/}/' >/tmp/base-peer-deps.txt
+    awk '/"peerDependencies": ?{/,/}/' "$file" >/tmp/current-peer-deps.txt
+
+    diff_output=$(diff -u /tmp/base-peer-deps.txt /tmp/current-peer-deps.txt || true)
+
+    changed_lines=$(echo "$diff_output" | grep -E '^[-+]' | grep -vE '^[-+]{3}')
+
+    if [ -n "$changed_lines" ]; then
+        echo "❌ peerDependencies changed in $file"
+        echo "$changed_lines"
+
+        {
+            echo "❌ peerDependencies changed in $file"
+            echo "$changed_lines"
+            echo ""
+        } >>"$result_file"
+
+        failed=1
+    else
+        echo "✔️ No change in peerDependencies in $file"
+    fi
+done
+
+rm -f /tmp/base-peer-deps.txt /tmp/current-peer-deps.txt
+
+echo ""
+if [ $failed -eq 1 ]; then
+    echo "❌ Breaking change detected: peerDependencies modified."
+    exit 1
+else
+    echo "✅ No peerDependencies changes found across all files."
+    exit 0
+fi