Skip to content

Commit f9bee22

Browse files
committed
docs: record the live ci-spot pool and hosted fallbacks
Supersede the stopgap sentences from 3484a7c, squash-merged as 693fd9e (#415, CR-170). Reword the runner-selection and timing assumptions from d093560 (#290) and the documentation-only runner sentence from 133f571 (#308); preserve the platform limits from 2394ba2 (#373). Record the 2026-10-18 live-pool bulletin, exact fragment and environment labels, class allocation, actor allowlist, hosted matrix legs and event fallbacks. Keep historical timings separate from unmeasured pool performance. No local verification run under the executor no-run rule.
1 parent 085dd6d commit f9bee22

1 file changed

Lines changed: 73 additions & 28 deletions

File tree

‎docs/ci.md‎

Lines changed: 73 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -826,9 +826,9 @@ that creates the branch, is forced or carries more than one commit, a merge
826826
that is not the pull request head's, a commit git cannot read, an empty change,
827827
and a `changes` job that fails or never answers.
828828

829-
Each proof job waits for `changes` alone, a few seconds once a standard runner
830-
takes it, and skips only when `changes` succeeded and answered
831-
documentation-only: `!cancelled() && (needs.changes.result != 'success' ||
829+
Each proof job waits for `changes` alone, a few seconds once the light ci-spot
830+
class or its hosted fallback takes it, and skips only when `changes` succeeded
831+
and answered documentation-only: `!cancelled() && (needs.changes.result != 'success' ||
832832
needs.changes.outputs.docs_only != 'true')`. `preflight` waits for nothing.
833833
The advisory `build` aggregate passes a proof job that succeeded, or one that
834834
was skipped under that same answer. A proof job skipped for any other reason
@@ -887,41 +887,84 @@ does not assume a build optimization without evidence.
887887

888888
## Runners and time limits
889889

890-
Every job in `ci.yml`, `native-live.yml` and `corpus-parity.yml` uses the free
891-
standard runners for every event, including pushes, schedules, manual
892-
dispatches and pull requests from this repository or a fork. Linux jobs use
893-
`ubuntu-24.04` (4 vCPU, 16 GB); the macOS `build` legs use `macos-26` (M1,
894-
3 cores, 7 GB). Larger runners bill even for a public repository, and their
895-
cost exceeded US$3,000: the owner's 2026-10-18 cost stop puts every job on
896-
standard runners. This is a stopgap until the ci-spot pool is live; its labels
897-
will replace the standard runner labels when that pool is ready.
890+
The ci-spot pool is live as of 2026-10-18 (bulletin #613, L6, 22:34). Linux
891+
x64 jobs use the fragments in `pf-ci-spot`'s `workflows/engine-x64-16.yml`
892+
and `workflows/public.yml` at `pf-ci-spot` commit `1fe46216` (bulletins
893+
#614/#615), with these exact label arrays:
894+
895+
| Jobs | Fragment and labels | Pool machine |
896+
| --- | --- | --- |
897+
| Linux `build` legs, `sanitizers`, `kernel-only`, all three `native-live` profiles, both corpus-parity jobs, release `prebuilt` Linux x64 leg | `engine-x64-16.yml`: `["self-hosted","pf-ci","pf-ci-x64-16"]` | e2-standard-16, 16 vCPU, 64 GB, 100 GB disk; engine only |
898+
| `changes`, `preflight`, both aggregate jobs, docs `build`, release metadata and hub notification, manual baseline promotion | `public.yml`: `["self-hosted","pf-ci","pf-ci-x64"]` | e2-standard-4, 4 vCPU, 16 GB, 30 GB disk |
899+
900+
This replaces the temporary standard-runner stopgap recorded by `3484a7c40`
901+
and squash-merged in `693fd9e68` (#415, CR-170) after GitHub larger-runner
902+
costs exceeded US$3,000. The runner-selection and timing sentences being
903+
reworded originated in `d0935605c` (#290), and the documentation-only runner
904+
sentence in `133f57148` (#308). The platform job limits from `2394ba2fc`
905+
(#373) remain in force.
906+
907+
Each Linux x64 job uses the fragment's expression verbatim and sets its
908+
matching array as a job-level **string** `PF_CI_LABELS`, merged into any
909+
existing job environment. The engine build fragment is:
898910

899911
```yaml
900-
runs-on: ubuntu-24.04
912+
runs-on: >-
913+
${{ github.event_name != 'pull_request_target' &&
914+
github.actor != 'dependabot[bot]' && github.triggering_actor != 'dependabot[bot]' &&
915+
contains(fromJSON('["push","pull_request","workflow_dispatch","schedule","release"]'), github.event_name) &&
916+
(github.event_name != 'pull_request' ||
917+
(github.event.pull_request.head.repo.full_name == github.repository && github.event.pull_request.head.repo.fork == false)) &&
918+
fromJSON('["self-hosted","pf-ci","pf-ci-x64-16"]') || 'ubuntu-latest' }}
919+
env:
920+
PF_CI_LABELS: '["self-hosted","pf-ci","pf-ci-x64-16"]'
901921
```
902922
903-
The `build` matrix selects its standard image with `runs-on: ${{ matrix.os }}`
904-
and names its four legs explicitly, so they stay `build (<image>, <type>)`.
905-
`native-live.yml` and `corpus-parity.yml` use `ubuntu-24.04` directly, whether
906-
called through CI or started independently. The advisory `build` aggregate
907-
and the `changes` job also use `ubuntu-24.04` for every event.
923+
The public fragment has the same expression with `pf-ci-x64` in both places.
924+
Pushes, manual dispatches, schedules, releases and same-repository pull
925+
requests whose head repository has `fork == false` take the pool when neither
926+
`github.actor` nor `github.triggering_actor` is `dependabot[bot]`. Dependabot
927+
runs and re-runs stay hosted through that guard. Fork pull
928+
requests, `pull_request_target`, `workflow_run` and every unlisted event fall
929+
back to `ubuntu-latest`. A reusable workflow sees its caller's `github`
930+
context, so native and corpus jobs keep the same fallback through CI.
931+
932+
The `build` matrix retains its four legs and their `build (<image>, <type>)`
933+
names. Its routing-only `include` entries carry the engine fragment for
934+
Linux and `macos-26` for macOS, selected with `runs-on: ${{ matrix.runner }}`.
935+
The two hosted macOS legs stay on `macos-26` (M1, 3 cores, 7 GB). Release's
936+
Linux x64 `matrix.runner` carries the same engine fragment; its ARM leg stays
937+
on `ubuntu-22.04-arm` and its universal macOS leg stays on `macos-latest`.
938+
The shared matrix jobs set the engine label string once; hosted legs ignore
939+
it. Promotion has both target and dispatch triggers: the target event stays
940+
hosted through the public fragment, while a manual dispatch can use the pool.
941+
942+
The dispatcher's actor allowlist is `luisleo526`, `pineforge-app[bot]` and
943+
`github-actions[bot]` (chain triggers only). Dependabot-specific jobs stay
944+
hosted; this repository currently has no Dependabot configuration or such job.
945+
The fragments do not extend that actor allowlist. The dispatcher accepts
946+
`pf-ci` plus exactly one class, with optional `self-hosted`, `linux` and that
947+
class's architecture and no duplicate labels. The pre-job hook also requires
948+
the matching `PF_CI_LABELS` string. ARM pool dispatch is disabled, so ARM stays
949+
hosted.
908950

909951
Each `ci_verify.py` call passes `--jobs "$(getconf _NPROCESSORS_ONLN)"` and
910952
`check_corpus_parity.sh` gets the same count as `JOBS`, so build and CTest
911-
parallelism follow the runner: 4 on Ubuntu and 3 on macOS. A documentation-only
953+
parallelism follow the runner: 16 on the build pool class and the available
954+
core count on hosted fallbacks (3 on the CI macOS image). A documentation-only
912955
change starts preflight alone among the verification jobs.
913956

914957
`scripts/ci_preflight.py` (`ci-workflow-contract`) pins every job's runner, time
915958
limit and parallelism in the three workflows a CI run starts, the `build`
916-
strategy block included, and keeps every other workflow -- `docs.yml`,
917-
`promote-baseline.yml` and any new one -- on standard runners. `release.yml`
918-
keeps its existing standard-runner matrix and is exempt from the fixed runner
919-
allowlist, by name and while its `on:` block names only events no fork can
920-
raise (a push, the schedule, a dispatch; a dispatch alone today). The contract
921-
refuses `pf-linux-x64-16`, any `*-xlarge` or `*-large` label, and any
922-
`larger_runner` key in every workflow, including `release.yml`. An event-based
923-
runner selection, a changed build matrix, a call to a workflow outside
924-
`.github/workflows/`, a changed time limit, a `ci_verify.py` call without
959+
strategy block included. It also pins the fragments and job-level
960+
`PF_CI_LABELS` in `docs.yml`, `promote-baseline.yml` and `release.yml`, the
961+
release matrix included. Release has no runner exemption. New Linux x64 jobs
962+
require the public fragment; target-only workflows and explicit
963+
Dependabot-only jobs stay hosted, as do macOS and ARM. The contract refuses
964+
`pf-linux-x64-16`, any `*-xlarge` or `*-large` label, and any `larger_runner`
965+
key in every workflow. A changed fragment, a missing, duplicate, non-string
966+
or mismatched `PF_CI_LABELS`, a changed build or release matrix, a call to a
967+
workflow outside `.github/workflows/`, a changed time limit, a `ci_verify.py` call without
925968
exactly one core-count `--jobs` (counted over the whole job, however its
926969
commands are chained, blocked or carried, with the flag and its value on one
927970
line), or any other `--jobs` or `JOBS` value fails preflight, and so does a jobs
@@ -972,7 +1015,9 @@ The standard-runner times are the eight CI runs from
9721015
main's 8cf3be58 (2026-09-24) to 0d76a099 (2026-09-25), pull requests included,
9731016
and the corpus-parity workflow's ten runs of 2026-09-22 to 2026-09-25. The
9741017
maintainers' x86-64 verification-host timings at 8 to 12 jobs remain separate
975-
measurements; the standard-runner timings describe the current runner policy.
1018+
measurements; the standard-runner timings describe the former hosted policy
1019+
and provide historical context for the ci-spot fallback. Pool timings await
1020+
measurements on the new runners.
9761021

9771022
| Job | Limit (min) | Measured basis |
9781023
| --- | --- | --- |

0 commit comments

Comments
 (0)