fix: update cypress.yml github action

Author: ReidyT

.github/workflows/cypress.yml

@@ -1,76 +1,54 @@
-name: Cypress
+name: Cypress UI tests
 
 on:
-  merge_group:
   push:
-    branches-ignore:
-      - 'release-please-**'
 
 jobs:
   cypress-run:
-    concurrency:
-      group: cypress-${{ github.head_ref || github.ref }}
+    concurrency: cypress-${{ github.head_ref || github.ref }}
     runs-on: ubuntu-latest
     steps:
-      - name: checkout
-        uses: actions/checkout@v3
-
-      - name: set up node
-        uses: actions/setup-node@v3
-        with:
-          node-version: '18'
+      - name: Checkout
+        uses: actions/checkout@v4
 
       - name: Yarn Install and Cache
         uses: graasp/graasp-deploy/.github/actions/yarn-install-and-cache@v1
         with:
           cypress: true
 
-      - name: cypress run
-        uses: cypress-io/github-action@v4
+      - name: Build App
+        run: yarn build:test
+        shell: bash
         env:
           VITE_PORT: 3000
-          VITE_GRAASP_API_HOST: http://localhost:3636
+          VITE_API_HOST: http://localhost:3636
           VITE_GRAASP_APP_KEY: id-1234567890
           VITE_ENABLE_MOCK_API: true
+          VITE_VERSION: cypress-tests
+
+      - name: Cypress Run
+        uses: cypress-io/github-action@v5
+        env:
+          VITE_PORT: 3000
+          VITE_API_HOST: http://localhost:3636
+          VITE_GRAASP_APP_KEY: id-1234567890
+          VITE_ENABLE_MOCK_API: true
+          VITE_VERSION: cypress-tests
         with:
-          wait-on: http://localhost:3000
-          wait-on-timeout: 180
           install: false
-          build: yarn build
           config: baseUrl=http://localhost:3000
-          start: yarn dev
+          start: yarn preview:test
           browser: chrome
           quiet: true
           # point to new cypress@10 config file
           config-file: cypress.config.ts
 
-      # component tests are not running ok in the CI
-      # - name: Run Component tests 🧪
-      #   uses: cypress-io/github-action@v4
-      #   with:
-      #     # we have already installed everything
-      #     install: false
-      #     # to run component tests we need to use "component: true"
-      #     component: true
-
-      # after the test run completes
-      # store videos and any screenshots
-      # NOTE: screenshots will be generated only if E2E test failed
-      # thus we store screenshots only on failures
-      # Alternative: create and commit an empty cypress/screenshots folder
-      # to always have something to upload
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
 
-      - uses: actions/upload-artifact@v3
-        if: failure()
-        with:
-          name: cypress-videos
-          path: cypress/videos
-
       - name: coverage report
         run: npx nyc report --reporter=text-summary
 
@@ -88,4 +66,4 @@ jobs:
           GITHUB_TOKEN: ${{ github.token }}
           REPO_PATH: ${{ github.repository }}
           COMMIT_SHA: ${{ github.sha }}
-          RUN_ID: ${{ github.run_id }}
+          RUN_ID: ${{ github.run_id }}

.github/workflows/deploy-dev.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Yarn build
         # Set environment variables required to perform the build. These are only available to this step
         env:
-          VITE_GRAASP_API_HOST: ${{ secrets.REACT_APP_API_HOST_DEV }}
+          VITE_API_HOST: ${{ secrets.REACT_APP_API_HOST_DEV }}
           VITE_GRAASP_APP_KEY: ${{ secrets.APP_KEY }}
           VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
         run: yarn build

.github/workflows/deploy-prod.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Yarn build
         # Set environment variables required to perform the build. These are only available to this step
         env:
-          VITE_GRAASP_API_HOST: ${{ secrets.REACT_APP_API_HOST_PROD }}
+          VITE_API_HOST: ${{ secrets.REACT_APP_API_HOST_PROD }}
           VITE_GRAASP_APP_KEY: ${{ secrets.APP_KEY }}
           VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
         run: yarn build

.github/workflows/deploy-stage.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Yarn build
         # Set environment variables required to perform the build. These are only available to this step
         env:
-          VITE_GRAASP_API_HOST: ${{ secrets.REACT_APP_API_HOST_STAGE }}
+          VITE_API_HOST: ${{ secrets.REACT_APP_API_HOST_STAGE }}
           VITE_GRAASP_APP_KEY: ${{ secrets.APP_KEY }}
           VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
         run: yarn build

README.md

@@ -7,7 +7,7 @@
   VITE_GRAASP_APP_KEY=<app KEY>
   VITE_ENABLE_MOCK_API=true
   VITE_GRAASP_DOMAIN=localhost
-  VITE_GRAASP_API_HOST=<request address for the backend>
+  VITE_API_HOST=<request address for the backend>
 ```
 
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/graasp/graasp-app-text-analysis?color=green&style=flat-square)

cypress/support/commands.ts

@@ -50,7 +50,7 @@ Cypress.Commands.add(
       win.appContext = {
         memberId: currentMember.id,
         itemId: MOCK_SERVER_ITEM.id,
-        apiHost: Cypress.env('VITE_GRAASP_API_HOST') || MOCK_SERVER_API_HOST,
+        apiHost: Cypress.env('VITE_API_HOST') || MOCK_SERVER_API_HOST,
         context: 'standalone',
         permission: PermissionLevel.Read,
         ...appContext,

docs/Setup_Intructions.md

@@ -359,7 +359,7 @@ jobs:
       - name: cypress run
         uses: cypress-io/github-action@v2
         env:
-          VITE_GRAASP_API_HOST: http://localhost:3636
+          VITE_API_HOST: http://localhost:3636
           VITE_GRAASP_DOMAIN: localhost
           VITE_GRAASP_APP_KEY: id-1234567890
           VITE_ENABLE_MOCK_API: true

src/config/env.ts

@@ -4,4 +4,4 @@ export const GOOGLE_ANALYTICS_ID = import.meta.env.VITE_GOOGLE_ANALYTICS_ID;
 export const ENABLE_MOCK_API =
   import.meta.env.VITE_ENABLE_MOCK_API === 'true' || false;
 export const GRAASP_API_HOST =
-  import.meta.env.VITE_GRAASP_API_HOST || 'http://localhost:3000';
+  import.meta.env.VITE_API_HOST || 'http://localhost:3000';