Merge pull request #42 from open-formulieren/feature/#31-ci

Feature/#31 ci

.eslintrc

@@ -6,7 +6,8 @@
     "plugin:prettier/recommended",
     "prettier/standard",
     "prettier/react",
-    "plugin:@typescript-eslint/eslint-recommended"
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:react/jsx-runtime"
   ],
   "env": {
     "node": true

.github/workflows/ci.yml

@@ -9,10 +9,40 @@ on:
     tags:
       - '*'
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      # - ready_for_review  relevant for chromatic, at some point
   workflow_dispatch:
 
+concurrency:
+  group: '${{ github.workflow }}-${{ github.ref_name }}' # unique builds for branch/tag name
+  cancel-in-progress: false  # do not cancel in progress, but only in-between builds
+
 jobs:
-  build-and-test:
+  storybook:
+    name: Create storybook build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: yarn
+
+      - name: Build Storybook docs
+        run: |
+          yarn install
+          yarn build-storybook --quiet
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./storybook-static
+
+  build-package:
     name: Create 'production' build
     runs-on: ubuntu-latest
 
@@ -27,11 +57,8 @@ jobs:
         run: yarn install
 
       - name: Build library
-        run: yarn build
-
-      # TODO: Not set up/configured yet
-      # - name: Run tests
-      #   run: yarn test
+        run: |
+          yarn build
 
       - name: Store build artifact
         uses: actions/upload-artifact@v3
@@ -41,7 +68,7 @@ jobs:
           retention-days: 1
 
   prettier:
-    name: Check frontend code formatting with prettier
+    name: prettier (code formatting)
     runs-on: ubuntu-latest
 
     steps:
@@ -57,12 +84,93 @@ jobs:
       - name: Run prettier linter
         run: yarn checkformat
 
+  eslint:
+    name: eslint (code formatting)
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run ESLint
+        run: yarn test:lint
+
+  tests:
+    name: Run Storybook tests
+    runs-on: ubuntu-latest
+    needs:
+      - storybook
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install
+
+      # Reference: https://storybook.js.org/docs/6.5/react/writing-tests/test-runner#run-against-non-deployed-storybooks
+      - name: Set up test environment
+        run: |
+          npx playwright install --with-deps
+
+      - name: Download storybook artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: github-pages
+          path: storybook-static
+
+      - name: Serve storybook and run tests
+        run: |
+          cd storybook-static/ && tar -xvf artifact.tar && cd ..
+          npx concurrently -k -s first -n "SB,TEST" -c "magenta,blue" \
+            "npx http-server storybook-static --port 6006 --quiet" \
+            "npx wait-on -l http://127.0.0.1:6006 && yarn test:storybook"
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs:
+      - storybook
+      - prettier
+      - eslint
+      - tests
+    # do not run in forks & only publish main branch
+    if: github.ref_name == 'main' && github.repository_owner == 'open-formulieren'
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    steps:
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
+
   publish:
     name: Publish the NPM package
     runs-on: ubuntu-latest
     needs:
-      - build-and-test
+      - build-package
       - prettier
+      - eslint
+      - tests
 
     # do not publish in forks or non-tag pushes
     if: startsWith(github.ref, 'refs/tags/') && github.repository_owner == 'open-formulieren'
@@ -77,7 +185,7 @@ jobs:
           scope: '@open-formulieren'
 
       - name: Install dependencies
-        run: yarn
+        run: yarn install
 
       - name: Download build artifact
         uses: actions/download-artifact@v3

package.json

@@ -19,8 +19,9 @@
     "build:cjs": "tsc -p tsconfig.prod.json --module commonjs --outDir dist/cjs && tsc-alias -p tsconfig.prod.json --outDir dist/cjs",
     "build:storybook": "build-storybook --webpack-stats-json",
     "build": "npm-run-all build:*",
-    "test": "run-s test:lint",
+    "test": "npm-run-all test:*",
     "test:lint": "eslint src/**/*.ts[x]",
+    "test:storybook": "test-storybook",
     "checkformat": "prettier --check 'src/**/*.{js,scss,ts,tsx,mdx}'",
     "format": "prettier --write 'src/**/*.{js,scss,ts,tsx,mdx}'",
     "start": "start-storybook -p 6006",
@@ -53,6 +54,7 @@
     "@storybook/jest": "^0.0.10",
     "@storybook/manager-webpack5": "^6.5.16",
     "@storybook/react": "^6.5.16",
+    "@storybook/test-runner": "^0.10.0",
     "@storybook/testing-library": "^0.0.13",
     "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/react": "^18.0.28",