Merge pull request #582 from zenml-io/future

Author: Cahllagerfeld

.env.example

@@ -0,0 +1,3 @@
+VITE_API_BASE_URL=
+VITE_FRONTEND_VERSION=
+VITE_FEATURE_OS_KEY=

.eslintignore

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.env*
+!.env.example
+
+pnpm-lock.yaml
+yarn.lock
+
+legacy
+scripts/types.js

.eslintrc.cjs

@@ -0,0 +1,25 @@
+module.exports = {
+	root: true,
+	env: { browser: true, es2020: true },
+	extends: [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/recommended",
+		"plugin:react-hooks/recommended"
+	],
+	ignorePatterns: ["dist", ".eslintrc.cjs"],
+	parser: "@typescript-eslint/parser",
+	plugins: ["react-refresh"],
+	rules: {
+		"react-refresh/only-export-components": ["warn", { allowConstantExport: true }],
+		"no-mixed-spaces-and-tabs": "off",
+		"@typescript-eslint/no-explicit-any": "warn",
+		"@typescript-eslint/no-unused-vars": [
+			"warn", // or "error"
+			{
+				argsIgnorePattern: "^_",
+				varsIgnorePattern: "^_",
+				caughtErrorsIgnorePattern: "^_"
+			}
+		]
+	}
+};

.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - name: Install dependencies
+        run: npm install -g pnpm && pnpm install
+      - name: Install Playwright Browsers
+        run: pnpm exec playwright install --with-deps
+      - name: Run Playwright tests
+        run: pnpm exec playwright test
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

.github/workflows/release.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
   push:
     tags:
-      - '*'
+      - "*"
 
 jobs:
   release:
@@ -13,44 +13,71 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
+
       - name: Get the version from the github tag ref
         id: get_version
         run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+
       - uses: actions/setup-node@v3
         with:
-          node-version: 18.16.0
+          node-version: 20
+
       - name: Install yarn
         run: npm install --global yarn
-      - name: Build
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: latest
+
+      - name: Build old dashboard
+        working-directory: ./legacy
         run: |
           yarn install
           yarn build
         env:
-          REACT_APP_HUB_API_URL: 'https://hubapi.zenml.io'
-          REACT_APP_BASE_API_URL: '/api/v1'
+          REACT_APP_HUB_API_URL: "https://hubapi.zenml.io"
+          REACT_APP_BASE_API_URL: "/api/v1"
           REACT_APP_MOCKAPI_RESPONSE: false
-          REACT_APP_USE_COOKIE: 'true'
+          REACT_APP_USE_COOKIE: "true"
           REACT_APP_VERSION: ${{ steps.get_version.outputs.VERSION }}
+
+      - name: Build new dashboard
+        run: |
+          pnpm install --frozen-lockfile
+          pnpm build
+        env:
+          VITE_API_BASE_URL: "/api/v1"
+          VITE_FRONTEND_VERSION: ${{ steps.get_version.outputs.VERSION }}
+          VITE_FEATURE_OS_KEY: ${{ secrets.FEATURE_OS_KEY }}
+
       - name: Generate Changelog
         uses: heinrichreimer/[email protected]
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          pullRequests: 'false'
-          onlyLastTag: 'true'
-          stripGeneratorNotice: 'true'
-          issuesWoLabels: 'true'
-          stripHeaders: 'true'
+          pullRequests: "false"
+          onlyLastTag: "true"
+          stripGeneratorNotice: "true"
+          issuesWoLabels: "true"
+          stripHeaders: "true"
+
       - name: Create release archive
         run: |
-          tar -zcf zenml-dashboard.tar.gz -C build --transform="s#\.\/##" .
+          tar -zcf zenml-dashboard-legacy.tar.gz -C ./legacy/build --transform="s#\.\/##" .
+          sha256sum -b zenml-dashboard-legacy.tar.gz > zenml-dashboard-legacy.tar.gz.sha256
+          tar -zcf zenml-dashboard.tar.gz -C dist --transform="s#\.\/##" .
           sha256sum -b zenml-dashboard.tar.gz > zenml-dashboard.tar.gz.sha256
+
+
       - name: Release to GitHub
         uses: softprops/action-gh-release@v1
         with:
           files: |
+            zenml-dashboard-legacy.tar.gz
+            zenml-dashboard-legacy.tar.gz.sha256
             zenml-dashboard.tar.gz
             zenml-dashboard.tar.gz.sha256
           body_path: ./CHANGELOG.md
-          prerelease: 'true'
+          prerelease: "true"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/unit-tests.yml

@@ -0,0 +1,36 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "20"
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: latest
+
+      - name: Install project dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run Unit Tests
+        run: pnpm test:unit

.gitignore

@@ -4,115 +4,28 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+pnpm-debug.log*
 lerna-debug.log*
 
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-.yarn/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-.env.development
-.env.production
-.DS_store
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
+node_modules
 dist
-
-# CRA build output
-build/
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your workspace uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# IntelliJ IDE directories
-.idea/
-
-!.env
-
-build
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+
+.env*
+!.env.example

.husky/pre-commit

@@ -1,3 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
-yarn prettier:fix && git add .
+
+npx lint-staged