Utility-contracts/.github/workflows/performance-regression.yml at 407a2698110d27f7b97f6eacdf065518dbf8c513 · Utility-Protocol/Utility-contracts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
name: Performance Regression Detection

# Automated performance regression detection for the webhook-delivery-service critical
# ingestion path (<100ms P99 SLO). Runs the benchmark on every PR against the committed
# baseline and fails the check when a metric regresses beyond tolerance or breaches the
# absolute SLO.
#
# Baseline refresh: dispatch this workflow manually with the `update_baseline` input set to
# `true` after a verified performance improvement. A PR that bumps the committed baseline is
# opened automatically (the baseline is never written to main directly).

on:
  workflow_dispatch:
    inputs:
      update_baseline:
        description: 'Refresh the committed performance baseline to this run (opens a PR)'
        required: false
        default: 'false'
  pull_request:
    branches: [main]
    paths:
      - 'webhook-delivery-service/**'
      - '.perf/**'
      - 'scripts/perf-regression-gate.sh'
      - '.github/workflows/performance-regression.yml'
  push:
    branches: [main]
    paths:
      - 'webhook-delivery-service/**'
      - '.perf/**'
      - 'scripts/perf-regression-gate.sh'

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  benchmark-gate:
    name: Benchmark & regression gate
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: webhook-delivery-service/package-lock.json

      - name: Run performance regression gate
        env:
          PERF_SAMPLES: 800
          PERF_WARMUP: 200
          PERF_TOLERANCE: 30
        run: ./scripts/perf-regression-gate.sh

      - name: Upload benchmark results artifact
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: perf-results
          path: .perf/results/latest.json
          if-no-files-found: ignore

  baseline-refresh:
    name: Refresh performance baseline
    runs-on: ubuntu-latest
    timeout-minutes: 20
    if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.update_baseline == 'true' }}
    permissions:
      contents: write
      pull-requests: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: webhook-delivery-service/package-lock.json

      - name: Run gate and refresh baseline
        env:
          PERF_SAMPLES: 1000
          PERF_WARMUP: 300
        run: ./scripts/perf-regression-gate.sh --update-baseline

      - name: Open baseline refresh PR
        uses: peter-evans/create-pull-request@v6
        with:
          branch: perf/baseline-refresh
          title: 'perf: refresh performance baseline'
          body: |
            Automated baseline refresh from workflow_dispatch.

            The webhook-ingestion benchmark passed against the previous baseline and the
            committed baseline (`.perf/perf-baselines.json`) has been updated to reflect the
            current measured performance. Review the delta before merging.
          commit-message: 'perf: refresh committed performance baseline'
          delete-branch: true
          labels: performance