performance-tests.yml

name: Performance Tests

on:
  workflow_dispatch:

jobs:
  build-and-test-performance:
    name: Performance Tests

    runs-on: ubuntu-latest
    timeout-minutes: 30

    steps:
      - name: Checkout
        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0

      - name: Use Node.js 18.x
        uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3.8.2
        with:
          node-version: "18.x"
          registry-url: "https://registry.npmjs.org"

      - name: Use Python 3.11
        uses: actions/setup-python@b64ffcaf5b410884ad320a9cfac8866006a109aa # v4.8.0
        with:
          python-version: '3.11'

      - name: Build
        shell: bash
        run: |
          yarn global add node-gyp
          yarn --skip-integrity-check --network-timeout 100000 --ignore-engines
          yarn build:examples
        env:
          NODE_OPTIONS: --max_old_space_size=4096
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # https://github.com/microsoft/vscode-ripgrep/issues/9

      - name: Performance (browser)
        shell: bash
        run: yarn performance:startup:browser

      - name: Performance (Electron)
        shell: bash
        run: xvfb-run yarn performance:startup:electron

      - name: Analyze performance results
        uses: benchmark-action/github-action-benchmark@fd31771ce86cc65eab85653da103f71ab1b4479c # v1.9.0
        with:
          name: Performance Benchmarks
          tool: "customSmallerIsBetter"
          output-file-path: performance-result.json
          alert-threshold: "150%"
          fail-on-alert: false
          github-token: ${{ secrets.GITHUB_TOKEN }} # Needed for comments an GH Pages
          benchmark-data-dir-path: tests/performance
          auto-push: true # Push to GH Pages
          comment-on-alert: true # Comment on commit if it causes a performance regression
          max-items-in-chart: 100 # Don't just collect results forever