@embrace-ai/infra-api-schema-sync 1.0.6 → 1.0.8

package/templates/workflows/graphql-schema-validate.yml

@@ -1,4 +1,3 @@
-# .github/workflows/graphql-schema-validate.yml
 name: Validate GraphQL Schema Updates
 
 on:
@@ -7,24 +6,30 @@ on:
   workflow_dispatch:
     inputs:
       schema_url:
-        description: "Schema URL to validate against"
-        required: false
-        default: ""
+        description: "GraphQL schema URL to validate/update"
+        required: true
+        type: string
+
+permissions:
+  id-token: write
+  contents: write
+  pull-requests: write
 
 jobs:
   validate-schema:
-    runs-on: ubuntu-latest
+    if: ${{ !startsWith(github.repository, 'Embrace-AI/template-') }}
+    runs-on: codebuild-GithubDev-${{ github.run_id }}-${{ github.run_attempt }}
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
 
       - name: Setup node cache
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v5
         with:
-          node-version: 22.16.0
+          node-version: 22.19.0
           cache: "pnpm"
 
       - name: Setup NPM
@@ -33,100 +38,174 @@ jobs:
         run: pnpm config set //registry.npmjs.org/:_authToken "${NPM_TOKEN}"
 
       - name: Install GraphQL schema sync tool
-        # Update line below to use the version you want
-        run: pnpm install -w @embrace-ai/infra-api-schema-sync@latest
+        run: pnpm add -g @embrace-ai/infra-api-schema-sync@latest
 
       - name: Configure aws credentials
-        uses: aws-actions/configure-aws-credentials@v4.2.1
+        uses: aws-actions/configure-aws-credentials@v5.0.0
         with:
           role-to-assume: ${{ secrets.AWS_DEPLOY_ROLE_DEV }}
           aws-region: ${{ vars.AWS_REGION }}
 
-      - name: Determine schema URL
-        id: schema-url
+      - name: Set schema URL and source repo
+        id: set-schema-url
         run: |
-          if [ "${{ github.event_name }}" = "repository_dispatch" ]; then
-            # Use the schema URL from the dispatch event
-            SCHEMA_URL="${{ github.event.client_payload.schemaUrl }}"
-            echo "📡 Using schema URL from dispatch event: $SCHEMA_URL"
-          elif [ -n "${{ github.event.inputs.schema_url }}" ]; then
-            # Use the schema URL from workflow_dispatch input
-            SCHEMA_URL="${{ github.event.inputs.schema_url }}"
-            echo "🔧 Using schema URL from workflow input: $SCHEMA_URL"
-          else
-            echo "❌ Error: No schema URL provided"
-            exit 1
+          SCHEMA_URL="${{ github.event.client_payload.schemaUrl || github.event.inputs.schema_url || '' }}"
+          if [ -z "$SCHEMA_URL" ]; then
+            echo "❌ schemaUrl not provided via repository_dispatch payload or workflow input"; exit 1
           fi
-          echo "url=$SCHEMA_URL" >> $GITHUB_OUTPUT
+          echo "schema_url=$SCHEMA_URL" >> "$GITHUB_OUTPUT"
 
       - name: Display schema update context
         run: |
-          if [ "${{ github.event_name }}" = "repository_dispatch" ]; then
-            echo "Schema update received from: ${{ github.event.client_payload.sourceRepo }}"
-            echo "Schema URL: ${{ github.event.client_payload.schemaUrl }}"
-            echo "Source commit: ${{ github.event.client_payload.commit }}"
-            echo "Source branch: ${{ github.event.client_payload.branch }}"
-            echo "Timestamp: ${{ github.event.client_payload.timestamp }}"
-          else
-            echo "Event type: ${{ github.event_name }}"
-            echo "Schema URL: ${{ steps.schema-url.outputs.url }}"
-          fi
+          echo "Schema update received from: ${{ github.event.client_payload.sourceRepo }}"
+          echo "Schema URL: ${{ steps.set-schema-url.outputs.schema_url }}"
+          echo "Source commit: ${{ github.event.client_payload.commit }}"
+          echo "Source branch: ${{ github.event.client_payload.branch }}"
+          echo "Timestamp: ${{ github.event.client_payload.timestamp }}"
 
       - name: Fetch updated schema
-        run: pnpm exec api-tool fetch --url ${{ steps.schema-url.outputs.url }} --output new-schema.graphql
+        run: api-tool fetch --url ${{ steps.set-schema-url.outputs.schema_url }} --output new-schema.graphql
 
+      - name: Update local schema files
+        id: update-schema
+        run: |
+          echo "🔍 Searching for local schema files to update..."
+          api-tool update-local-schema \
+            --schema-url "${{ steps.set-schema-url.outputs.schema_url }}" \
+            --schema-file new-schema.graphql \
+            --output schema-update-result.json
+
+          # Read the results
+          if [ -f schema-update-result.json ]; then
+            SERVICE_NAME=$(jq -r '.serviceName // "unknown"' schema-update-result.json)
+            UPDATED_COUNT=$(jq -r '.updatedFiles | length' schema-update-result.json)
+            HAS_CHANGES=$(jq -r '.hasChanges' schema-update-result.json)
+
+            echo "service_name=$SERVICE_NAME" >> $GITHUB_OUTPUT
+            echo "updated_count=$UPDATED_COUNT" >> $GITHUB_OUTPUT
+            echo "has_changes=$HAS_CHANGES" >> $GITHUB_OUTPUT
+
+            if [ "$HAS_CHANGES" = "true" ]; then
+              echo "✅ Updated $UPDATED_COUNT schema file(s) for service: $SERVICE_NAME"
+              jq -r '.updatedFiles[]' schema-update-result.json | while read file; do
+                echo "  - $file"
+              done
+            else
+              echo "ℹ️  No changes detected in schema files"
+            fi
+          else
+            echo "has_changes=false" >> $GITHUB_OUTPUT
+            echo "⚠️  No schema files found to update"
+          fi
       - name: Validate queries against new schema
         id: validate
-        run: pnpm exec api-tool validate --schema new-schema.graphql --queries 'src/**/*.graphql' --output report.json
+        run: api-tool validate --schema new-schema.graphql --queries 'src/**/*.graphql' --output report.json
 
       - name: Check for issues
         id: check-issues
         run: |
-          if [ -s report.json ] && [ "$(jq 'length' report.json)" -gt 0 ]; then
+          if [ -s report.json ] && [ "$(jq '.issues | length' report.json)" -gt 0 ]; then
             echo "has_issues=true" >> $GITHUB_OUTPUT
-            echo "issue_count=$(jq 'length' report.json)" >> $GITHUB_OUTPUT
+            echo "issue_count=$(jq '.issues | length' report.json)" >> $GITHUB_OUTPUT
           else
             echo "has_issues=false" >> $GITHUB_OUTPUT
             echo "issue_count=0" >> $GITHUB_OUTPUT
           fi
 
-      - name: Generate summary
+      - name: Generate validation summary
         id: gen-summary
-        if: steps.check-issues.outputs.has_issues == 'true'
-        run: pnpm exec api-tool summarize --report report.json --output GRAPHQL_ISSUES.md && echo "summary=$(cat GRAPHQL_ISSUES.md)" >> $GITHUB_OUTPUT
+        run: |
+          # Always generate summary, even if no issues (for consistency)
+          if [ ! -f report.json ]; then
+            echo "[]" > report.json
+          fi
+          api-tool summarize --report report.json --output GRAPHQL_ISSUES.md
+
+          # Also generate a summary of updated files
+          if [ -f schema-update-result.json ]; then
+            echo "## 📝 Updated Schema Files" > SCHEMA_CHANGES.md
+            echo "" >> SCHEMA_CHANGES.md
+            jq -r '.updatedFiles[]' schema-update-result.json | while read file; do
+              echo "- \`$file\`" >> SCHEMA_CHANGES.md
+            done
+            echo "" >> SCHEMA_CHANGES.md
+          fi
+
+          # Expose summaries as step outputs for later steps (multiline-safe)
+          {
+            echo 'issues_summary<<EOF'
+            cat GRAPHQL_ISSUES.md
+            echo EOF
+          } >> $GITHUB_OUTPUT
+
+          {
+            echo 'schema_changes<<EOF'
+            if [ -f SCHEMA_CHANGES.md ]; then
+              cat SCHEMA_CHANGES.md
+            else
+              echo "- No files updated"
+            fi
+            echo EOF
+          } >> $GITHUB_OUTPUT
+      - name: Clean up non-source artifacts before PR
+        run: |
+          rm -f new-schema.graphql report.json GRAPHQL_ISSUES.md SCHEMA_CHANGES.md schema-update-result.json
 
-      - name: Commit and create PR with issues
+      - name: Commit and create PR
+        if: steps.update-schema.outputs.has_changes == 'true'
+        id: create-pr
         uses: peter-evans/create-pull-request@v6
         with:
-          commit-message: "chore(api): GraphQL schema update${{ github.event_name == 'repository_dispatch' && format(' from {0}', github.event.client_payload.sourceRepo) || '' }}"
+          commit-message: "chore(api): Update GraphQL schema for ${{ steps.update-schema.outputs.service_name }}${{ github.event_name == 'repository_dispatch' && format(' from {0}', github.event.client_payload.sourceRepo) || '' }}"
           branch: "graphql/schema-update-${{ github.run_id }}"
-          title: "GraphQL Schema Update (${{ steps.check-issues.outputs.issue_count }} issues)"
+          title: "GraphQL Schema Update - ${{ steps.update-schema.outputs.service_name }} (${{ steps.check-issues.outputs.issue_count }} issues)"
           body: |
             # GraphQL Schema Update Impact Report
 
-            ${{ github.event_name == 'repository_dispatch' && format('**Schema Source:** {0}', github.event.client_payload.sourceRepo) || '' }}
-            **Schema URL:** ${{ steps.schema-url.outputs.url }}
-            ${{ github.event_name == 'repository_dispatch' && format('**Source Commit:** {0}', github.event.client_payload.commit) || '' }}
-            ${{ github.event_name == 'repository_dispatch' && format('**Source Branch:** {0}', github.event.client_payload.branch) || '' }}
-            ${{ github.event_name == 'repository_dispatch' && format('**Update Time:** {0}', github.event.client_payload.timestamp) || '' }}
-            **Trigger:** ${{ github.event_name }}
+            ## Summary
+
+            **Service:** `${{ steps.update-schema.outputs.service_name }}`
+            **Updated Files:** ${{ steps.update-schema.outputs.updated_count }}
+            **Validation Issues:** ${{ steps.check-issues.outputs.issue_count }}
+            **Status:** ${{ steps.check-issues.outputs.has_issues == 'true' && '⚠️ Action Required' || '✅ Ready to Merge' }}
+
+            ---
+
+            ## Schema Files Updated
+
+            The following schema files have been updated with the latest schema from the source:
+
+            ${{ steps.gen-summary.outputs.schema_changes }}
+
+            ---
+
+            ## ${{ steps.check-issues.outputs.has_issues == 'true' && '⚠️ Validation Issues Found' || '✅ No Validation Issues' }}
+
+            ${{ steps.check-issues.outputs.has_issues == 'true' && 'The following GraphQL queries are incompatible with the updated schema and need to be fixed:\n\n' || 'All existing GraphQL queries are compatible with the updated schema. No changes to queries are required.\n\n' }}${{ steps.gen-summary.outputs.issues_summary }}
 
             ---
-            ## ${{ steps.check-issues.outputs.has_issues == 'true' && 'Detected Issues' || '🎉 No Issues Found' }}
-            ${{ steps.check-issues.outputs.has_issues == 'true' && steps.gen-summary.outputs.summary || 'The updated schema is compatible with your existing GraphQL queries' }}
 
-            ## Next Steps
-            1. Review any compatibility issues above
-            2. Update your GraphQL queries to match the new schema
-            3. Test your changes thoroughly
-            4. Merge this PR once all issues are resolved
+            ## Source Information
 
-      - name: Display validation results (for manual runs)
+            ${{ github.event_name == 'repository_dispatch' && format('- **Schema Source:** {0}', github.event.client_payload.sourceRepo) || '' }}
+            - **Schema URL:** ${{ github.event.client_payload.schemaUrl }}
+            ${{ github.event_name == 'repository_dispatch' && format('- **Source Commit:** {0}', github.event.client_payload.commit) || '' }}
+            ${{ github.event_name == 'repository_dispatch' && format('- **Source Branch:** {0}', github.event.client_payload.branch) || '' }}
+            ${{ github.event_name == 'repository_dispatch' && format('- **Update Time:** {0}', github.event.client_payload.timestamp) || '' }}
+            - **Trigger:** ${{ github.event_name }}
+
+            ---
+
+            ## 🚀 Next Steps
+
+            ${{ steps.check-issues.outputs.has_issues == 'true' && '1. ⚠️ **Review the validation issues above**\n2. 🔧 **Update the affected GraphQL queries** to match the new schema\n3. **Test your changes**\n4.  **Push your fixes** to this branch\n5. **Merge this PR** once all issues are resolved' || '1. **Review the schema changes** in the Files Changed tab\n2. **Verify the changes** look correct\n3. **Merge this PR** to update your schema' }}
+
+      - name: Display validation results
         if: github.event_name == 'workflow_dispatch'
         run: |
-          echo "## 📊 GraphQL Schema Validation Results" >> $GITHUB_STEP_SUMMARY
+          echo "## GraphQL Schema Validation Results" >> $GITHUB_STEP_SUMMARY
           echo "" >> $GITHUB_STEP_SUMMARY
-          echo "**Schema URL:** ${{ steps.schema-url.outputs.url }}" >> $GITHUB_STEP_SUMMARY
+          echo "**Schema URL:** ${{ steps.set-schema-url.outputs.schema_url }}" >> $GITHUB_STEP_SUMMARY
           echo "**Event:** ${{ github.event_name }}" >> $GITHUB_STEP_SUMMARY
           echo "" >> $GITHUB_STEP_SUMMARY
 
@@ -142,12 +221,14 @@ jobs:
             echo "The schema is compatible with all existing GraphQL queries." >> $GITHUB_STEP_SUMMARY
           fi
 
-      - name: Create success comment
-        if: steps.check-issues.outputs.has_issues == 'false'
+      - name: No changes needed
+        if: steps.update-schema.outputs.has_changes == 'false'
         run: |
-          echo "✅ No GraphQL compatibility issues found!"
-          if [ "${{ github.event_name }}" = "repository_dispatch" ]; then
-            echo "Schema from ${{ github.event.client_payload.sourceRepo }} is compatible with existing queries."
-          else
-            echo "Schema from ${{ steps.schema-url.outputs.url }} is compatible with existing queries."
+          echo "✅ Schema is already up to date - no PR needed"
+          echo "### ✅ Schema Already Up To Date" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "The fetched schema matches the current schema file(s). No changes or action needed." >> $GITHUB_STEP_SUMMARY
+          if [ "${{ steps.check-issues.outputs.has_issues }}" = "false" ]; then
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "All existing queries are compatible with the schema." >> $GITHUB_STEP_SUMMARY
           fi