Repository navigation
133 lines (120 loc) · 5.54 KB
/
Copy pathlighthouse.yml
File metadata and controls
133 lines (120 loc) · 5.54 KB
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
name: Lighthouse
on:
pull_request:
workflow_dispatch:
permissions:
contents: read
pull-requests: write
# Including `github.workflow` in the key keeps this from colliding with any
# other workflow that happens to share a ref-based group prefix.
concurrency:
group: lighthouse-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
lighthouse:
name: Lighthouse audit
runs-on: ubuntu-24.04
timeout-minutes: 15
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0
with:
bun-version: 1.4.2
# Bun is the package manager and script runner, but Next.js (and the
# lhci binary) run on Node. The runner image is pinned (ubuntu-24.04)
# but Node version inside it can still drift; pin via .nvmrc so a
# future GitHub bump can't break the audit silently.
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version-file: .nvmrc
# Cache Bun's resolved package store keyed on the lockfile hash.
- name: Cache Bun install cache
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
path: ~/.bun/install/cache
key: ${{ runner.os }}-bun-${{ hashFiles('bun.lock') }}
restore-keys: |
${{ runner.os }}-bun-
# Cache Next.js's incremental build output. Keyed on lockfile + commit
# SHA so the exact-key match is always per-commit fresh; restore-keys
# fall back to any previous build on the same lockfile so most CI runs
# hit a cache and skip rebuilding unchanged webpack modules.
- name: Cache Next.js build cache
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
path: ${{ github.workspace }}/.next/cache
key: ${{ runner.os }}-nextjs-${{ hashFiles('bun.lock') }}-${{ github.sha }}
restore-keys: |
${{ runner.os }}-nextjs-${{ hashFiles('bun.lock') }}-
${{ runner.os }}-nextjs-
- name: Install
run: bun install --frozen-lockfile
- name: Build
run: bun run build
# The action handles starting the server (per lighthouserc.cjs's
# `startServerCommand`), running Lighthouse against each URL, asserting
# the thresholds, and uploading reports to temporary public storage.
# Threshold rationale lives in lighthouserc.cjs alongside the values.
- name: Lighthouse CI
id: lighthouse
uses: treosh/lighthouse-ci-action@3e7e23fb74242897f95c0ba9cabad3d0227b9b18 # v12
with:
configPath: ./lighthouserc.cjs
uploadArtifacts: true
temporaryPublicStorage: true
# Build a markdown table from the .lighthouseci/lhr-*.json reports.
# `unique_by(.url)` collapses duplicate rows if `numberOfRuns > 1`
# (the action writes the median LHR per URL, but be defensive);
# `sort_by(.url)` keeps row order deterministic across runs.
# `if: always()` so the PR comment still posts when assertions fail —
# reviewers can see *which* category regressed without digging through
# the workflow log.
#
# Per-cell emoji follows Lighthouse's own scoring buckets: 🟢 ≥90,
# 🟡 50–89, 🔴 <50. Floor thresholds in lighthouserc.cjs are below
# the 🟢 cutoff, so a cell can pass assertions and still show 🟡 — the
# visual signals "we locked this in but it's improvable."
- name: Format PR comment
if: always() && github.event_name == 'pull_request' && steps.lighthouse.outputs.links != ''
id: lh-comment
env:
LINKS_JSON: ${{ steps.lighthouse.outputs.links }}
run: |
{
echo 'body<<COMMENT_EOF'
echo '## 🔦 Lighthouse audit'
echo ''
echo '| URL | Perf | A11y | Best practices | SEO | Report |'
echo '|---|:---:|:---:|:---:|:---:|---|'
jq -s --argjson links "$LINKS_JSON" -r '
def emo(s): if s >= 90 then "🟢" elif s >= 50 then "🟡" else "🔴" end;
def cell(s): emo(s) + " " + (s | tostring);
map({
url: .finalUrl,
perf: (.categories.performance.score * 100 | floor),
a11y: (.categories.accessibility.score * 100 | floor),
bp: (.categories["best-practices"].score * 100 | floor),
seo: (.categories.seo.score * 100 | floor)
})
| unique_by(.url)
| sort_by(.url)
| map(
"| `" + (.url | sub("^https?://[^/]+"; "")) + "`"
+ " | " + cell(.perf)
+ " | " + cell(.a11y)
+ " | " + cell(.bp)
+ " | " + cell(.seo)
+ " | [report](" + ($links[.url] // "#") + ") |"
)
| join("\n")
' .lighthouseci/lhr-*.json
echo ''
echo "_Run [\`${GITHUB_RUN_ID}\`](${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}) · $(date -u +'%Y-%m-%d %H:%M UTC')_"
echo 'COMMENT_EOF'
} >> "$GITHUB_OUTPUT"
- name: Post or update PR comment
if: github.event_name == 'pull_request' && steps.lh-comment.outputs.body != ''
uses: marocchino/sticky-pull-request-comment@5770ad5eb8f42dd2c4f34da00c94c5381e49af88 # v3.0.5
with:
header: lighthouse
message: ${{ steps.lh-comment.outputs.body }}