ci: add integration tests

Integration tests run in the CI and check if the
demo application builds with the versions of @ngrx/signals
as defined in the package.json.

Author: rainerhahnekamp

.github/workflows/build.yml

@@ -17,4 +17,5 @@ jobs:
           cache: 'npm'
       - run: npm i
       - run: npm run build:all
+      - run: ./integration-tests.sh
 

.gitignore

@@ -40,3 +40,4 @@ Thumbs.db
 
 .nx/cache
 .angular
+/versions.txt

integration-tests.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# This uses different NgRx versions and verifies that the demo app builds.
+
+set -e
+
+echo 'checking against different @ngrx/signals versions'
+
+./read-supported-versions.js
+
+i=0
+while read line
+do
+  versions[$i]="$line"
+  i=$((i+1))
+done < versions.txt
+
+for version in ${versions[*]}; do
+  npm i @ngrx/signals@$version
+  echo "Building with version $version"
+  npx nx build --project demo
+done

libs/ngrx-toolkit/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/angular-architects/ngrx-toolkit"
   },
   "peerDependencies": {
-    "@ngrx/signals": "18.0.0-rc.1 || 18.0.0-rc.2"
+    "@ngrx/signals": "18.0.0-rc.2"
   },
   "dependencies": {
     "tslib": "^2.3.0"

nx.json

@@ -79,6 +79,5 @@
     "@nx/angular:component": {
       "style": "css"
     }
-  },
-  "nxCloudAccessToken": "MDc5ZjM0OWMtZGJkZC00YWRjLWFjOTctYzYzMDc4MDUyMjkwfHJlYWQtd3JpdGU="
+  }
 }

read-supported-versions.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+/**
+ * Reads the supported versions of @ngrx/signals from the package.json and saves
+ * them into a file, which is then consumed by the integrations tests.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+// Define the path to the package.json file
+const packageJsonPath = path.join(
+  __dirname,
+  'libs/ngrx-toolkit',
+  'package.json'
+);
+// Define the path for the output file
+const outputPath = path.join(__dirname, 'versions.txt');
+
+// Read the package.json file
+fs.readFile(packageJsonPath, 'utf8', (err, data) => {
+  if (err) {
+    console.error('Error reading package.json:', err);
+    return;
+  }
+
+  // Parse the JSON content
+  const packageJson = JSON.parse(data);
+
+  // Extract dependencies
+  const peerDependencies = packageJson.peerDependencies;
+  if (!peerDependencies?.['@ngrx/signals']) {
+    throw new Error('Could not find @ngrx/signals in peerDependencies');
+  }
+
+  const versions =
+    peerDependencies['@ngrx/signals']
+      .split('||')
+      .map((version) => version.trim())
+      .join(os.EOL) + os.EOL;
+
+  fs.writeFileSync(outputPath, versions);
+});