benchmark.yml

name: Benchmark Proxy
on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main
  workflow_dispatch:

env:
  CARGO_TERM_COLOR: always

permissions:
  # deployments permission to deploy GitHub pages website
  deployments: write
  # contents permission to update benchmark contents in gh-pages branch
  contents: write

jobs:
  benchmark:
    name: Performance regression check
    runs-on: buildjet-16vcpu-ubuntu-2204
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/setup-test
      - run: |
          mise run postgres:up --extra-args "--detach --wait"
      - name: Run benchmark
        working-directory: tests/benchmark
        env:
          CS_WORKSPACE_ID: ${{ secrets.CS_WORKSPACE_ID }}
          CS_CLIENT_ACCESS_KEY: ${{ secrets.CS_CLIENT_ACCESS_KEY }}
          CS_DEFAULT_KEYSET_ID: ${{ secrets.CS_DEFAULT_KEYSET_ID }}
          CS_CLIENT_ID: ${{ secrets.CS_CLIENT_ID }}
          CS_CLIENT_KEY: ${{ secrets.CS_CLIENT_KEY }}
          RUST_BACKTRACE: "1"
        run: mise run benchmark:continuous
      # Download previous benchmark result from cache (if exists)
      - name: Download previous benchmark data
        uses: actions/cache@v4
        with:
          path: ./cache
          key: ${{ runner.os }}-benchmark
      # Run `github-action-benchmark` action
      - name: Store benchmark result
        uses: benchmark-action/github-action-benchmark@v1
        with:
          # What benchmark tool the output.txt came from
          tool: 'pgbench'
          # Where the output from the benchmark tool is stored
          output-file-path: tests/benchmarks/results/output.txt
          # Where the previous data file is stored
          external-data-json-path: ./cache/benchmark-data.json
          # Workflow will fail when an alert happens
          fail-on-alert: true
          # Enable alert commit comment
          comment-on-alert: true
          # GitHub API token to make a commit comment
          github-token: ${{ secrets.GITHUB_TOKEN }}
          # Enable Job Summary for PRs
          summary-always: true
          auto-push: true