Add JSON API data check to CI (#459)

#SkipVersionBump

Author: lukasmatta

.github/workflows/cps-shared-ui-checkers.yml

@@ -82,3 +82,30 @@ jobs:
           start: npm run start
           browser: chrome
           wait-on: http://localhost:4200
+
+  generate-api-data:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate API data and check for changes
+        id: generate-api
+        run: |
+          npm run generate-json-api
+          if [[ -n "$(git status --porcelain projects/composition/src/assets/api-data/)" ]]; then
+            echo "API data has changed. Please commit the updated API data.";
+            git --no-pager diff projects/composition/src/assets/api-data/
+            exit 1;
+          else
+            echo "No changes in API data.";
+          fi

.github/workflows/cps-ui-kit-publish.yml

@@ -19,10 +19,10 @@ jobs:
         with:
           ssh-key: ${{ secrets.DEPLOY_KEY }}
 
-      - name: Use Node.js v20.x
+      - name: Use Node.js v22.x
         uses: actions/setup-node@v3
         with:
-          node-version: 20.x
+          node-version: 22.x
           registry-url: 'https://registry.npmjs.org'
 
       - name: Bump version
@@ -55,10 +55,10 @@ jobs:
       - name: Fetch latest commits
         run: git pull origin master
 
-      - name: Use Node.js v20.x
+      - name: Use Node.js v22.x
         uses: actions/setup-node@v3
         with:
-          node-version: 20.x
+          node-version: 22.x
           registry-url: 'https://registry.npmjs.org'
 
       - name: Cache node_modules

.github/workflows/publish-documentation.yml

@@ -14,96 +14,9 @@ on:
       - '.github/**'
 
 jobs:
-  # Generate api data
-  generate-api-data:
-    if: "!contains(github.event.head_commit.message, 'Update autogenerated JSON files')"
-    runs-on: ubuntu-latest
-    # Permissions needed to create PR and write content
-    permissions:
-      contents: write
-      pull-requests: write
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Use Node.js v20.x
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Generate API data
-        working-directory: ./projects/composition
-        run: |
-          npm run generate-json-api
-
-      # Instead of direct commit/push, create a PR
-      - name: Create Pull Request
-        id: cpr
-        uses: peter-evans/create-pull-request@v6
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          # More descriptive commit message
-          commit-message: 'chore: Update API documentation JSON files'
-          # Use bot account for better tracking
-          committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
-          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
-          # Unique branch name using run number to avoid conflicts
-          branch: api-docs-update-${{ github.run_number }}
-          # Auto-delete branch after merge
-          delete-branch: true
-          title: 'chore: Update API documentation JSON files'
-          # Detailed PR description with context
-          body: |
-            ## Auto-generated API Documentation Update
-
-            This PR contains automatically generated API documentation files.
-
-            ### Changes
-            - Updated JSON API files based on latest component changes
-
-            ### Workflow Run
-            - Triggered by commit: ${{ github.sha }}
-            - Run ID: ${{ github.run_id }}
-
-            ---
-
-            🤖 This PR was automatically created by the documentation workflow.
-          # Labels for organization and to skip changelog
-          labels: |
-            documentation
-            automated
-            skip-changelog
-
-      # Auto-merge the PR (requires repo settings to allow auto-merge)
-      - name: Enable Pull Request Automerge
-        if: steps.cpr.outputs.pull-request-operation == 'created'
-        uses: peter-evans/enable-pull-request-automerge@v3
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
-          merge-method: squash
-
-      # Auto-approve the PR so it can be merged
-      - name: Auto approve PR
-        if: steps.cpr.outputs.pull-request-operation == 'created'
-        uses: hmarr/auto-approve-action@v4
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
-
   # Build job
   build:
     runs-on: ubuntu-latest
-    needs: generate-api-data
-    # Only run if generate-api-data succeeded or was skipped (not failed)
-    if: always() && (needs.generate-api-data.result == 'success' || needs.generate-api-data.result == 'skipped')
 
     steps:
       - name: Checkout code

projects/composition/src/app/api-data/cps-datepicker.json

@@ -151,7 +151,7 @@
                         "name": "value",
                         "optional": false,
                         "readonly": false,
-                        "type": "null | Date",
+                        "type": "Date | null",
                         "default": "null",
                         "description": "Value of the datepicker."
                     }
@@ -165,7 +165,7 @@
                         "parameters": [
                             {
                                 "name": "value",
-                                "type": "null | Date"
+                                "type": "Date | null"
                             }
                         ],
                         "description": "Callback to invoke on value change."

projects/composition/src/app/api-data/cps-radio-group.json

@@ -7,7 +7,7 @@
                 "values": [
                     {
                         "name": "option",
-                        "optional": false,
+                        "optional": true,
                         "readonly": false,
                         "type": "CpsRadioOption",
                         "description": "An option."

projects/composition/src/app/api-data/cps-timepicker.json

@@ -105,7 +105,7 @@
                         "name": "value",
                         "optional": false,
                         "readonly": false,
-                        "type": "undefined | CpsTime",
+                        "type": "CpsTime | undefined",
                         "description": "Value of the timepicker."
                     }
                 ]