From 745b970077bd4f2d655ad059a8038f1f60e31b36 Mon Sep 17 00:00:00 2001 From: Cameron Reeves Date: Thu, 6 Aug 2026 02:10:33 +1000 Subject: [PATCH] docs(e2e): describe the trigger set the workflow actually has MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The CI section still described stage 1 — nightly, e2e/** and manual — and said the nightly could not start until the suite landed on develop. Both are now out of date: pushes to develop, release/** and rc/** trigger a run, and the suite has been on develop since #476. Also records why there are no path filters, and why the set stops short of feature branches, so the next person to consider changing either has the reasoning rather than having to rediscover it. Co-Authored-By: Claude Fable 5 --- e2e/README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/e2e/README.md b/e2e/README.md index ef6414643b..eabbe1560a 100644 --- a/e2e/README.md +++ b/e2e/README.md @@ -205,14 +205,21 @@ depend on an external service, which is the one thing it is designed not to do. ## CI -`.github/workflows/e2e-advisory.yml` — runs nightly at **01:10 UTC**, on pushes to `e2e/**`, -and via **Run workflow**. There is deliberately **no `pull_request` trigger** (see the table -below — it is a security decision, not an oversight). It brings up the isolated stack, seeds -it, runs the suite, writes a step summary, and uploads the HTML report plus (on failure) -traces, videos and backend container logs. - -`schedule` only fires from the default branch, so the nightly does not start accumulating a -track record until this lands on `develop`. +`.github/workflows/e2e-advisory.yml` — runs on pushes to **`develop`, `release/**`, `rc/**`** +and `e2e/**`, nightly at **01:10 UTC**, and via **Run workflow**. There is deliberately **no +`pull_request` trigger** (see the table below — it is a security decision, not an oversight), +so a push is the only thing that covers a merge. It brings up the isolated stack, seeds it, +runs the suite, writes a step summary, and uploads the HTML report plus (on failure) traces, +videos and backend container logs. + +There are no path filters, on purpose — most real changes touch `libs/**`, which workplace +depends on, and the genuinely dangerous ones (`bun.lock`, `tsconfig.base.json`, `config/`) are +the easiest to leave off an include-list. A filter that is 95% right silently skips the run +that mattered. + +Note the push set deliberately stops short of feature branches: there is one self-hosted +runner binding fixed host ports, so runs serialise, and a busy trigger set would build a queue +that starves the nightly. **It is advisory and must stay that way for now** — do not add it to branch protection or required status checks until the suite has a track record. See the CI section of