CI: remove the Documentation Team Review Requests workflow - #117019
CI: remove the Documentation Team Review Requests workflow#117019groeneai wants to merge 2 commits into
Conversation
…l is added
`Documentation Team Review Requests` starts one run per `pull_request_target`
event, but only one event per pull request arms real work: `opened` for an
internal pull request, `labeled` with `can be tested` for a fork. Every other
event produces a run whose two jobs both evaluate `if:` to false and conclude
`skipped`. GitHub delivers the arming event once and nothing re-sends it, so the
runs at one head are not interchangeable and a discarded arming run cannot be
recovered.
Two GitHub behaviours were discarding it. `cancel-in-progress: true` cancels a
run that is already executing, and the default `queue: single` cancels and
replaces a run that is merely pending. A pull request normally receives three to
six of these events within seconds of being opened, so both fired routinely: 36
of 300 runs in one 16.5 hour window ended `cancelled`, across four head
repositories.
The `${{ github.event_name }}` term in the group looks like the cause but is not.
It was added when the workflow had two triggers, `pull_request` for internal pull
requests and `pull_request_target` for forks, purely to stop
`cancel-in-progress: true` cancelling across the two paths. Consolidating both
onto `pull_request_target` left the term constant, which widened the blast radius
to the internal path as well, but the term was only ever a mitigation for the
cancellation and never a fix for it.
Measured loss: ClickHouse#116943, docs-only and merged, had its `opened` run 33207978258
cancelled one second later by a `pr-autogenerated-docs` label run that then
skipped. It merged with zero `review_requested` events although
`get_docs_teams_to_request` returns `integrations-ecosystem` and `docs` for its
changed files. The nine other docs pull requests in that window, whose arming
runs survived, all received their expected teams.
`cancel-in-progress: false` keeps a running arming run alive and `queue: max`
raises the pending limit from one to 100. The group is left alone, so a pull
request's runs still serialise and two of them never race the same
`requested_reviewers` call; letting duplicates run instead of cancelling them is
safe because the job submits only the teams that are not already requested.
Writing `cancel-in-progress: false` explicitly rather than deleting the line
keeps the coupling legible, since pairing `queue: max` with
`cancel-in-progress: true` is a documented workflow validation error.
The `ci/tests/` guard pins both settings. The `ci_tests` digest gains this
workflow because the job digests `./ci` plus four explicit extra files, not
`.github/`, so without that entry a change confined to this workflow would leave
the job a cache hit and the guard would never run on it.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Internal second-model review: adjudication log (click to expand)Pre-publication review by an independent model (engine: codex; 0 findings), plus my own cold
Severity: ❌ blocker /
I re-measured the description's countable claims on a fresh clock before publishing, including #116210 is the only other open pull request touching this file. It changes the two Session id: cron:clickhouse-review-slot-8:20260829-060400 |
Pre-PR validation gate (click to expand)
Extra validation beyond the table: Session id: cron:clickhouse-impl-slot-4:20260829-053500 |
|
Workflow [PR], commit [7b396af] Summary: ✅ AI ReviewSummaryThis PR deletes the standalone Final Verdict✅ No review findings in the current diff. |
|
cc @Blargian, could you review this? |
|
@groeneai I think we just need a better solution overall. Please remove Documentation Team Review Requests workflow and I will find out how to do it without the need for a separate workflow. |
Blargian, who authored the workflow and the mechanism behind it, asked for the workflow to be removed so that documentation review requests can be driven from an existing workflow instead of a separate one: ClickHouse#117019 (comment) This is an intentional removal rather than a fix. With the workflow gone no documentation review request is made at all until that replacement lands. Today they are made unreliably: 42 of the workflow's 300 runs in the 18 hours to 2026-08-29T07:45Z ended cancelled, and ClickHouse#116943 merged without either of the two teams it was owed. It supersedes the concurrency fix this branch previously carried, so the guard under ci/tests and the digest entry pointing at the deleted file are reverted. Both existed only to protect that file. ci/jobs/scripts/team_review_requests.py and GH.request_team_reviews are left in place. They hold the path-to-team routing and the request submission, so a replacement invoked from an existing workflow can call them unchanged.
|
@Blargian done in I left This stops documentation team requests entirely until your replacement lands. If you want cover in the meantime, the previous commit #116210 is my other open pull request, fixing the checkout revision in the same file. It is redundant if this merges, and I have not touched it. |
Changelog category (leave one):
Changelog entry (a user-readable short description of the changes that goes into CHANGELOG.md):
The
Documentation Team Review Requestsworkflow is removed.Description
@ Blargian asked for the workflow to be removed rather than fixed, so that documentation
review requests can be driven from an existing workflow instead of a separate one:
#117019 (comment)
This is an intentional removal, not a fix. Once it merges, no documentation review request is
made at all until a replacement lands. Today they are made unreliably: 42 of the workflow's
300 runs in the 18 hours to 2026-08-29T07:45Z ended
cancelled, and #116943 merged with zeroreview_requestedevents although the routing owed itintegrations-ecosystemanddocs.Only the workflow is deleted.
ci/jobs/scripts/team_review_requests.pyandGH.request_team_reviewsare left in place: they hold the path-to-team routing and therequest submission, so a replacement invoked from an existing workflow can call them
unchanged.
This branch previously carried a concurrency fix for the same problem. That is reverted here,
together with the
ci/tests/guard and the digest entry, which existed only to protect thedeleted file.
#116210 is my open pull request correcting the checkout revision in this same workflow. It
becomes unnecessary if this one merges, and I have left its disposition alone.