Repository navigation
Conversation
In this commit, we add docs/ci-runs.md to explain which CI workflows run for pull requests, merge-queue entries, and nightly master runs. The document maps each tier to its jobs, explains how the CI result check handles skips and failures, and describes the shared Go, Docker image, and lint analysis caches. The guide also covers label controls, the PR rebase step, failure artifacts, and the release-related workflows, so a contributor can find the relevant check without reading the full workflow YAML. The contribution guide links to the new document.
github-actions
Bot
added
ci-hold
🟢 PR Severity: LOW
🟢 Low (3 files)
AnalysisThis PR only touches documentation files ( To override, add a |
Add a quick reference, a tier selection flowchart, a PR lifecycle state diagram, a tier by job matrix, and flowcharts for releasing a held PR, for how CI result decides, for the nightly report and for the caches. End with a troubleshooting table.
The release notes check only accepts the headings of the template, so the fragment would fail it once CI runs.
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.
In this PR, we add
docs/ci-runs.mdto explain which CI workflows run for pull requests, merge-queue entries, and nightly master runs. The document maps each tier to its jobs, explains howCI resulthandles skips and failures, and describes the shared Go, Docker image, and lint analysis caches.The guide also covers label controls, the rebase step, failure artifacts, and the release-related workflows, so a contributor can find the relevant check without reading the full workflow YAML. The contribution guide links to the new document.
Anchor:
7669a85c04.Diagrams: one trigger/tier flowchart and one
ci-resultsequence diagram. Both rendered locally withmmdcsyntax checking; the sandbox cannot launch Chrome, so final rendering is verified on the pushed GitHub page.Known gaps: the guide summarizes the main validation and release workflows; the repository-assistant workflows are indexed without internal detail.