ci-perf.yml

---
name: "📊 Build Performance"

# Note! you can't safely use "pull_request_target" here
# This workflow is mostly useful for "internal PRs"
# External PRs won't be able to post a PR comment
#
# See https://github.com/preactjs/compressed-size-action/issues/54
# See https://securitylab.github.com/research/github-actions-preventing-pwn-requests
on:
  pull_request:
    branches: [main, next]
    paths:
      - "crowdin.yml"
      - "sidebars.js"
      - "package.json"
      - "pnpm-lock.yaml"
      - "babel.config.js"
      - "docusaurus.config.ts"
      - "src/**"
      - "static/**"
      - "!docs/**"
      - "!blog/**"
      - "!i18n/**"
      - "!community/**"
      - "!ecosystem/**"

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read

env:
  URL: "https://wiki.zshell.dev"

jobs:
  build-size:
    name: " 📊 Build Size Report"
    timeout-minutes: 30
    runs-on: ubuntu-latest
    permissions:
      checks: write # for preactjs/compressed-size-action to create and update the checks
      contents: read # for actions/checkout to fetch code
      pull-requests: write # for preactjs/compressed-size-action to write a PR review
      issues: write # for preactjs/compressed-size-action to create comments
    steps:
      - name: "⤵️ Check out code from GitHub"
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: "📦 Setup pnpm"
        uses: pnpm/action-setup@v2.4.0
      - name: "⎔ Setup node"
        uses: actions/setup-node@v4.0.1
        with:
          node-version: current
          cache: "pnpm"
      - run: pnpm i --prod
      - uses: preactjs/compressed-size-action@v2
        with:
          build-script: "build:en"
          pattern: "{build/assets/js/*.js,build/assets/css/*.css,build/**/*.html,.docusaurus/globalData.json,build/blog/**/swiss-army-knife-for-zsh/*}"
          exclude: "{./build/manifest.json,./build/**/*.xml,**/*.map,**/node_modules/**,build/assets/**/*.ttf}"
          strip-hash: '\.([^;]\w{7})\.'
          minimum-change-threshold: 30
          compression: none

  build-time:
    name: 💹 Build Time Perf
    timeout-minutes: 30
    runs-on: ubuntu-latest
    steps:
      - name: "⤵️ Check out code from GitHub"
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: "📦 Setup pnpm"
        uses: pnpm/action-setup@v2.4.0
      - name: "⎔ Setup node"
        uses: actions/setup-node@v4.0.1
        with:
          node-version: current
          cache: "pnpm"
      - run: pnpm i --prod
      # Ensure build with a cold cache does not increase too much
      - name: "Build (cold cache)"
        run: pnpm build:en
        timeout-minutes: 8
      # Ensure build with a warm cache does not increase too much
      - name: "Build (warm cache)"
        run: pnpm build:en
        timeout-minutes: 2