docs(source-control): REST-poll CI waits; queued vs running (#3955) - #4834
Merged
Merged
Conversation
Forbid gh pr checks --watch for a long wait (GraphQL cost grows with queue time). Before the first poll, report each pending Actions job as queued (with runs-on labels) or running. Closes #3955 Co-authored-by: Kyle Sexton <kyle-sexton@users.noreply.github.com>
…est-polling-37e9 Co-authored-by: Kyle Sexton <kyle-sexton@users.noreply.github.com>
Contributor
|
PR body contract — issue linkage This PR body does not yet satisfy the issue-linkage contract:
Edit the body and this comment updates itself on the next run. |
…est-polling-37e9 Co-authored-by: Kyle Sexton <kyle-sexton@users.noreply.github.com>
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
2 participants
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.
Closes #3955
Summary
babysit-prsandpull-requestnow say how to wait for a pending check: REST on a fixed schedule, nevergh pr checks --watch, and a queued job is reported as queued (with itsruns-onlabels) rather than as a slow job.Decision
--watchon a still-queuedtestjob; 63 minutes of queue time on a saturated self-hosted pool). GitHub REST jobs / runners / check-runs docs as stamped inmonitor.md.gh pr checks --watchleaves GraphQL, or when the runners list endpoints change their admin permission.Fix
pull-request/reference/monitor.mdgains "Waiting on a pending check":--watchis named as the thing not to use (GraphQL cost grows with queue time; a job that has not started still burns the budget). The wait is the existing REST check-runs read at 30s (Monitor) or 60-90s (blocking / cloud).N/M busy) is added only when the token can list runners (admin). A 403 is reported as unread, not guessed.babysit-prsloop.mdandstuck-checks.md, and thepull-requestcadence line, point at that section.Test plan
checks --watchnow appears as the forbidden form inmonitor.md,loop.md, andstuck-checks.md.monitor.md"Waiting on a pending check".