docs(contributing): document the ci tiers, the rig, and suite invariants - #474
Merged
Conversation
BSpendlove
temporarily deployed
to
integration-rig
August 18, 2026 03:39 — with
GitHub Actions
Inactive
BSpendlove
temporarily deployed
to
integration-rig
August 18, 2026 10:26 — with
GitHub Actions
Inactive
BSpendlove
temporarily deployed
to
integration-rig
August 18, 2026 10:33 — with
GitHub Actions
Inactive
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The contributor docs describe a CI model the project no longer runs. Both
please_read_first.mdandguidelines.mdstate that build and unit tests are the only gate a PR clears, and that integration tests run only after a merge to main, so they never run against a PR. Every PR now also clears a core set of integration suites on the self-hosted rig, with the full matrix nightly and again before a release. Nothing documents the rig, the tiers, or the invariants a new containerlab suite has to carry, so a contributor adding a suite has to rediscover them by failing.Change
A new page, CI and Review, covering what runs on a PR and where, the three tiers and why the per-PR set is deliberately a subset, how the rig allocates CPU slots and stores evidence, how to run suites locally against the same dataplane CI uses, the invariants a new suite must carry and the failure each one prevents, what a reviewer checks, and the osvbng-vpp and pin-bump flow. The two stale paragraphs are corrected to point at it, and it joins the nav.
The suite invariants are the section worth reviewing closest: the IPv4-only management network, the
:=autoCPU slot templating, per-suite bridge and veth names,OSVBNG_RESPAWN, gating restart checks on the state file rather than the log line, and the twelve minute budget. Each is written with the failure it prevents, because each was learned from one.Verification
mkdocs.yml parses and the new page is in the nav. Prose only, no code or workflow changes. Every claim about CI behaviour is drawn from runs on this repository over the last day, including the timeout-reads-as-cancelled note and the fork-PR approval state.
Not merged deliberately
Left open for maintainer review rather than self-merged.