docs(ci): visual gate-map (md + HTML) + CodeQL query-suite note#141
Merged
Conversation
Note in the codeql.yml section that the query suite deliberately stays on security-and-quality rather than the leaner security-extended: trimming was weighed for speed, but with CodeQL off the PR path its runtime no longer blocks anyone, so shrinking would only drop the quality queries for no gain.
A diagram-first companion to docs/CI.md for contributors: the change-filter → gate → ci-success flow, the outside-the-PR-gate rail, a full gate table, and a what-runs-when matrix. ci-gate-map.md renders natively on GitHub; the self-contained ci-gate-map.html carries the full-colour, both-theme version for a browser. Both cross-link and name CI.md as the source of truth.
bastien-gallay
changed the title
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
1 participant
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.
Two docs-only additions, both companions to
docs/CI.md(which stays thesource of truth).
Visual CI gate-map
For contributors who want the spatial mental model, not the full runbook:
docs/ci-gate-map.md— diagram-first, renders natively on GitHub: thechanges→ filter-lane →ci-successflow, the outside-the-PR-gate rail,a full gate table, and a what-runs-when matrix.
docs/ci-gate-map.html— the same in full colour, self-contained(inline CSS, light + dark), for viewing in a browser.
docs/CI.mdas the source of truth;CI.mdlinksback to them.
CodeQL query-suite note
Records in
CI.md§3 that the suite deliberately stays onsecurity-and-qualityrather thansecurity-extended: trimming was weighedfor speed, but with CodeQL off the PR path (#138) its runtime no longer blocks
anyone, so shrinking would only drop the quality queries for no gain.
Docs-only: the change-focused CI skips every Rust job here;
markdownlintrunsand
ci-successgates.