check.yml

name: Check code quality
on:
  pull_request:
  workflow_dispatch:

# cancel previous runs if new changes are pushed to the branch/PR
# see: https://stackoverflow.com/a/72408109
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  check:
    name: Check code quality
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          # needed when building VitePress docs so timestamps can be calculated correctly
          fetch-depth: 0

      - uses: pnpm/action-setup@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version-file: .node-version
          cache: pnpm

      - name: 📦 Install dependencies
        run: pnpm install

      - name: 🔎 Lint
        run: pnpm run lint:ci:all
        # we must continue on error here so the eslint results are uploaded to GitHub in the next step.
        continue-on-error: true

      - name: Upload eslint results to GitHub
        uses: github/codeql-action/upload-sarif@v3
        with:
          sarif_file: eslint-results.sarif
          wait-for-processing: true

      - name: 🔎 Check formatting
        run: pnpm run format:check:all

      - name: 🛠️ Build packages
        run: pnpm run build:all
        env:
          # skip fetching statistics for our docs here so we don't exceed GitHub rate limits which may fail in CI
          VITEPRESS_SKIP_GITHUB_FETCH: true

      - name: 🚨 Run unit tests
        run: pnpm run test:all

      # make sure that publint is only run after all packages have been built
      - name: Run publint
        run: pnpm run publint:all

      - name: Upload code coverage artifact
        uses: actions/upload-artifact@v4
        if: always() # needed to also upload test results when they failed (useful for debugging)
        with:
          name: coverage
          path: packages/sit-onyx/coverage

      - name: Upload Storybook artifact
        uses: actions/upload-artifact@v4
        with:
          name: storybook-static
          path: packages/sit-onyx/storybook-static

      - name: Upload documentation artifact
        uses: actions/upload-artifact@v4
        with:
          name: documentation
          path: apps/docs/src/.vitepress/dist

  screenshots:
    name: Component tests
    uses: ./.github/workflows/playwright.yml