Merge pull request #1 from SuperViz/pr/checks

ci: setup realtime build and pr checks
SuperViz · Sep 13, 2024 · 56705a3 · 56705a3
2 parents 52bacc4 + 2e69994
commit 56705a3
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 21 deletions.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -0,0 +1,79 @@
+name: Run Checks
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+jobs:
+  delete-comments:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: izhangzhihao/delete-comment@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          delete_user_name: SuperViz-Dev
+          issue_number: ${{ github.event.number }}
+  build:
+        runs-on: ubuntu-latest
+        strategy:
+          matrix:
+            node-version: [20]
+        steps:
+          - uses: actions/checkout@v4
+          - name: Install pnpm
+            uses: pnpm/action-setup@v4
+            with:
+              version: 9.10.0
+          - name: Use Node.js ${{ matrix.node-version }}
+            uses: actions/setup-node@v4
+            with:
+              node-version: ${{ matrix.node-version }}
+              cache: 'pnpm'
+          - name: Install dependencies
+            run: pnpm install --no-frozen-lockfile
+            env:
+              NPM_CONFIG_USERCONFIG: .npmrc.ci
+              NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          - name: Create a .version.js file
+            run: |
+              touch packages/realtime/.version.js && echo "echo \"export const version = 'test'\" > .version.js" | bash -
+          - name: Create a .remote-config.js file
+            run: |
+              touch packages/realtime/.remote-config.js && echo "echo \"module.exports = { remoteConfig: { apiUrl: 'https://dev.nodeapi.superviz.com' }};\" > .remote-config.js" | bash -
+          - name: Run builds
+            run: pnpm run build
+  test-unit-realtime:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.10.0
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install --no-frozen-lockfile
+        env:
+          NPM_CONFIG_USERCONFIG: .npmrc.ci
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Create a .version.js file
+        run: |
+          touch packages/realtime/.version.js && echo "echo \"export const version = 'test'\" > .version.js" | bash -
+      - name: Create a .remote-config.js file
+        run: |
+          touch packages/realtime/.remote-config.js && echo "echo \"module.exports = { remoteConfig: { apiUrl: 'https://dev.nodeapi.superviz.com' }};\" > .remote-config.js" | bash -
+      - name: Run tests
+        run: pnpm run test:unit:ci --filter=@superviz/realtime
+      - name: Post PR Comment
+        run: npx github-actions-ctrf packages/realtime/ctrf/ctrf-report.json --pr-comment
+        if: always()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/packages/realtime/.gitignore b/packages/realtime/.gitignore
@@ -131,6 +131,7 @@ dist
 
 dist/
 coverage/
+ctrf/
 .DS_Store
 .version.js
 .remote-config.js
diff --git a/packages/realtime/jest.config.js b/packages/realtime/jest.config.js
@@ -17,4 +17,8 @@ module.exports = {
     '^.+\\.js$': 'ts-jest',
   },
   setupFiles: ['<rootDir>/jest.setup.js'],
+  reporters: [
+    'default',
+    ['jest-ctrf-json-reporter', {}],
+  ],
 };
diff --git a/packages/realtime/package.json b/packages/realtime/package.json
@@ -54,12 +54,12 @@
   },
   "homepage": "https://github.com/SuperViz/realtime#readme",
   "devDependencies": {
-    "@superviz/eslint-config": "workspace:*",
-    "@superviz/typescript-config": "workspace:*",
     "@commitlint/cli": "^19.3.0",
     "@commitlint/config-conventional": "^19.2.2",
     "@esm-bundle/chai": "^4.3.4-fix.0",
     "@jest/globals": "^29.7.0",
+    "@superviz/eslint-config": "workspace:*",
+    "@superviz/typescript-config": "workspace:*",
     "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.14.8",
@@ -69,6 +69,7 @@
     "eslint": "8.56.0",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
+    "jest-ctrf-json-reporter": "^0.0.9",
     "semantic-release": "^24.0.0",
     "semantic-release-version-file": "^1.0.2",
     "ts-jest": "^29.2.5",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/turbo.json b/turbo.json
@@ -22,6 +22,8 @@
       "dependsOn": ["^watch"]
     },
     "build": {
+      "cache": false,
+      "persistent": false,
       "dependsOn": ["^build"],
       "inputs": ["$TURBO_DEFAULT$", ".env*"],
       "outputs": [".next/**", "!.next/cache/**"]
@@ -32,6 +34,21 @@
     "dev": {
       "cache": false,
       "persistent": true
+    },
+    "@superviz/realtime#build": {
+      "dependsOn": ["@superviz/socket-client#build"]
+    },
+    "@superviz/realtime#test:unit": {
+      "dependsOn": ["@superviz/socket-client#build"]
+    },
+    "@superviz/realtime#test:unit:watch": {
+      "dependsOn": ["@superviz/socket-client#build"]
+    },
+    "@superviz/realtime#test:unit:coverage": {
+      "dependsOn": ["@superviz/socket-client#build"]
+    },
+    "@superviz/realtime#test:unit:ci": {
+      "dependsOn": ["@superviz/socket-client#build"]
     }
   }
 }