#36574 ci: Reword stale readme
| Reviewability | Reviews | Agreement | Size | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| #36574 ci: Reword stale readme | Ready | 0 | Neutral | 0 + 26 tests | ||||||
|
|
|
|
| ||||||
Reviewability: ReadyStalePaused Agreement: StrongPositivePositive w/ caveatsNeutralMildDisputedBlockedCrickets Reviews: current code-review ACKs, then (+stale ACKs) and -NACKs; greener = more ACKs. Size: lines added or modified outside tests, then in tests; greener = smaller. | ||||||||||
Goal
Updates `ci/README.md` to reflect current container environments and CI harness mechanics. It replaces recommendations for an unmaintained QEMU binfmt container with modern Docker-recommended tooling, removes inaccurate claims that numbered CI scripts run sequentially, clarifies how container images and build caches are handled, and documents the policy against universally pinning CI dependencies by hash.
Problem: Contributors running CI tasks locally or inspecting CI mechanics encounter outdated documentation, including unmaintained QEMU helper images, incorrect explanations of script execution order, and missing context on CI dependency pinning policies.
Evidence of importance:
- Commit fabc10bc59 notes: 'docker.io/multiarch/qemu-user-static hasn't been updated in years and the replacement according to the Docker docs is tonistiigi/binfmt.'
- Commit fa5edac158 notes: 'Remove note that scripts are ordered. They are not: 02_run_container.py runs before 01_base_install.sh and some scripts have no number: GetCMakeLogFiles.cmake, wrap-valgrind.py, ...'
Risk of a mistake: low (docs). Touches only developer documentation for CI without altering any executable build or test scripts.
Changed since the previous assessment: The depends cache description references `./depends` instead of `../depends`.
Reviewability
Ready
Nothing known that would invalidate a review now.
Waiting on (from the thread read):
- reviewer: l0rinc to consider maflcko's reply regarding docker and dependency pinning 2026-10-22
Agreement
Neutral
objections settled, nobody has spoken for the PR
Thread notes: maflcko replied to l0rinc's pushback in rc:4348252227 arguing docker is an external dependency unrelated to pinning, moving the objection back to answered.
Objections, suggestions, and questions:
| Reviewer | Type | Harm, request, or question | Status | Must be | Author replied | Quote |
|---|---|---|---|---|---|---|
| Hamza1610 (none) | suggestion, interface | Clarify whether path references like ../depends are relative to the ci directory or the project root. | answered · author replied that they dropped the change instead of clarifying paths | answered | yes | 2026-10-20: 'I would suggest you clarify on the path references.' Status from: 2026-10-21: maflcko: 'thx, dropped the change instead. Seems better to leave paths as-is.' |
| l0rinc (member) | objection, approach | The rationale arguing against dependency pinning is incomplete and ignores that pinning prevents silent updates to buggy versions and helps narrow down inconsistencies. | answered · author replied that the docker issue is an external dependency not managed in this repo and unrelated to pinning | answered | yes | 2026-10-20: 'I don't agree with this, but I won't block the change. These are all valid statements, but it's not complete.' Status from: 2026-10-22: maflcko: 'So the docker issue 35202 is unrelated to pinning and the issue would happen again with or without pinning.' |
Participants:
- Hamza1610 (none, neutral, 1 statements 2026-10-20 to 2026-10-20): suggested clarifying path references; author answered by dropping the change
- l0rinc (member, objection, 3 statements 2026-10-20 to 2026-10-21): disagrees with the readme's characterization of dependency pinning
Files
42 lines under test/bench/ci.
- ci/README.md +26/-16
Card
The short text the ranking pass compares across PRs.
Updates ci/README.md to bring local CI setup instructions and harness documentation up to date. It replaces references to an unmaintained multiarch QEMU helper container with current upstream guidance, removes inaccurate descriptions of CI script ordering, clarifies container image and ccache behavior, and adds a section explaining the project's dependency hash pinning policy. This aids contributors attempting to understand or replicate CI environments locally.
Data
thread read through 2026-10-22 (8 statements), head faebf98d5b
labels: Tests
Categories
Build and CI
P4 · cleanup
Updates stale documentation for running CI containers locally. It replaces unmaintained QEMU binfmt container recommendations and corrects notes on script execution order, which has minor value for developers but no impact on CI operation or build integrity.
Membership: Modifies ci/README.md to update container environment recommendations and clarify CI harness mechanics.
Factors: security/stability 0, bug 0, performance 0, user value 0, leverage 0
Test infrastructure
P4 · cleanup
Edits documentation explaining CI test harness mechanics without changing test runners or test code. The updates fix minor inaccuracies for developers inspecting test workflows.
Membership: Carries the Tests label and documents how test runners and containers are invoked in CI.
Factors: security/stability 0, bug 0, performance 0, user value 0, leverage 0