pages-deploy.yml

# Based on https://gist.github.com/AndrewLester/2d3e6257d932831756226ca9a281d9b5
name: Build and Deploy to Pages

on:
  push:
    branches:
      - main
    paths:
      - src/**
      - static/**
      - package.json
      - pnpm-lock.yaml
      - "*.config.*s"
      - tsconfig.json
      - .github/workflows/*
  pull_request:
    paths:
      - src/**
      - static/**
      - package.json
      - pnpm-lock.yaml
      - "*.config.*s"
      - tsconfig.json
      - .github/workflows/*

# Start the workflow
jobs:
  permissions-check:
    name: Permissions check
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    outputs:
      has-permissions: ${{ steps.check-output.outputs.has-permissions }}

    steps:
      - name: ❓ Has access to secrets?
        id: secrets-check
        continue-on-error: true
        uses: actions/checkout@v3
        with:
          repository: ${{ github.event.repository.full_name }}
          ref: ${{ github.head_ref }}
          token: ${{ secrets.WORKFLOW_PAT }}

      - name: 📤 Set output
        id: check-output
        if: always()
        run: echo "has-permissions=${{ steps.secrets-check.outcome == 'success' && 'true' || 'false' }}" >> $GITHUB_OUTPUT

  prechecks:
    name: Pre-checks
    runs-on: ubuntu-latest
    needs: permissions-check
    if: github.event_name == 'pull_request' && !failure() && !cancelled()
    permissions:
      contents: write

    steps:
      - name: 📂 Checkout
        uses: actions/checkout@v3
        with:
          repository: ${{ github.event.repository.full_name }}
          ref: ${{ github.head_ref }}
          token: ${{ needs.permissions-check.outputs.has-permissions == 'false' && github.token || secrets.WORKFLOW_PAT }}

      - name: 📥 Install pnpm
        uses: pnpm/action-setup@v2
        with:
          version: latest

      - name: 🧭 Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: latest
          cache: pnpm

      - name: 📥 Install NPM dependencies
        run: pnpm i --no-frozen-lockfile

      - name: 🔍 Detect file changes
        id: detect-changes-pnpm
        run: |
          if [[ $(git diff --name-only) =~ pnpm-lock.yaml ]]; then
            echo "changes_detected=true >> $GITHUB_OUTPUT"
          else
            echo "changes_detected=false >> $GITHUB_OUTPUT"
          fi

      - name: ❌ Exit if lock file is not updated
        if: needs.permissions-check.outputs.has-permissions == 'false' && steps.detect-changes-pnpm.outputs.changes_detected == 'true'
        run: exit 1

      - name: 📤 Commit updated lock file
        id: auto-commit-action-lock
        if: needs.permissions-check.outputs.has-permissions == 'true'
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Update lock file
          file_pattern: pnpm-lock.yaml

      - name: ❌ Exit if lock file has been committed
        if: needs.permissions-check.outputs.has-permissions == 'true' && steps.auto-commit-action-lock.outputs.changes_detected == 'true'
        run: exit 1

      - name: 🔧 Check Inlang config
        run: pnpm ci:update-inlang

      - name: 🔍 Detect file changes
        id: detect-changes-inlang
        run: |
          if [[ $(git diff --name-only) =~ inlang.config.js ]]; then
            echo "changes_detected=true >> $GITHUB_OUTPUT"
          else
            echo "changes_detected=false >> $GITHUB_OUTPUT"
          fi

      - name: ❌ Exit if Inlang config is not updated
        if: needs.permissions-check.outputs.has-permissions == 'false' && steps.detect-changes-inlang.outputs.changes_detected == 'true'
        run: exit 1

      - name: 📤 Commit updated Inlang config
        id: auto-commit-action-inlang
        if: needs.permissions-check.outputs.has-permissions == 'true'
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Update Inlang config
          file_pattern: inlang.config.js

      - name: ❌ Exit if Inlang config has been committed
        if: needs.permissions-check.outputs.has-permissions == 'true' && steps.auto-commit-action-inlang.outputs.changes_detected == 'true'
        run: exit 1

      - name: ✨ Check Svelte format
        run: pnpm check

      - name: ✨ Check style with Prettier & ESLint
        id: lint-check
        run: pnpm lint

      - name: 🔧 Fix lint
        if: failure() && needs.permissions-check.outputs.has-permissions == 'true'
        run: pnpm format

      - name: 📤 Commit lint fixes
        if: failure() && needs.permissions-check.outputs.has-permissions == 'true'
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Fix lint

  build:
    name: Build website
    runs-on: ubuntu-latest
    needs: prechecks
    if: (!failure() || github.event_name == 'push') && !cancelled()

    steps:
      - name: 📂 Checkout
        uses: actions/checkout@v3
        with:
          repository: ${{ github.event.repository.full_name }}
          ref: ${{ github.head_ref }}

      - name: 🔧 Configure pages
        uses: actions/configure-pages@v3
        if: github.event_name != 'pull_request'
        id: pages
        with:
          static_site_generator: sveltekit

      - name: 📥 Install pnpm
        uses: pnpm/action-setup@v2
        with:
          version: latest

      - name: 🧭 Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: latest
          cache: pnpm

      - name: 📥 Install NPM dependencies
        run: pnpm i # no need for `--no-frozen-lockfile` here, as the sync is ensured by the `prechecks` job

      - name: 🔨 Build repo
        run: pnpm build

      - name: 📤 Upload artifact
        if: github.event_name == 'push'
        uses: actions/upload-pages-artifact@v2
        with:
          path: ./build

  deploy:
    name: Deploy website to GitHub Pages
    runs-on: ubuntu-latest
    needs: build
    if: github.event_name == 'push' && !failure() && !cancelled()
    concurrency:
      group: pages
      cancel-in-progress: true
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    outputs:
      page_url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: 🌍 Deploy Pages
        uses: actions/deploy-pages@v2
        id: deployment

  perf-check:
    name: Performance checks
    runs-on: ubuntu-latest
    needs: deploy
    if: github.event_name == 'push' && !failure() && !cancelled()

    steps:
      - name: ⚓️ Unlighthouse check
        run: |
          npm i -g @unlighthouse/cli puppeteer
          unlighthouse-ci --site ${{ needs.deploy.outputs.page_url }} --budget 75

      - name: 📤 Upload artifact
        uses: actions/upload-artifact@v3
        with:
          name: unlighthouse-result
          path: .unlighthouse/ci-result.json