Key the doc build concurrency group on the pull request number - #7174
Open
albertvillanova wants to merge 1 commit into
Open
Key the doc build concurrency group on the pull request number#7174albertvillanova wants to merge 1 commit into
albertvillanova wants to merge 1 commit into
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Member
Author
|
|
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.
What does this PR do?
build_pr_documentation.ymlkeys its concurrency group ongithub.head_ref, which is the head branch name without the fork owner. Two open PRs from different forks that both use a branch calledpatch-1therefore land in the same group, and a push on one cancels the in-flight doc build on the other.github.event.pull_request.numberis unique per pull request. This workflow only triggers onpull_request, so thegithub.run_idfallback is never reached, but it is kept so the block stays identical to the one intests.ymlandtests-experimental.yml. Happy to drop it if you would rather the expression say only what this workflow needs.Bugbot found the same pattern on #7170 (comment), where it had been copied from here. No two of the 182 currently open PRs share a head branch name, but 130 of them come from forks, so the collision is reachable.
Note
Low Risk
Single CI workflow concurrency expression change with no runtime or application impact.
Overview
Fixes cross-PR doc build cancellations when multiple forks use the same branch name (e.g.
patch-1).The Build PR Documentation workflow’s
concurrency.groupnow usesgithub.event.pull_request.numberinstead ofgithub.head_ref, so each PR gets its own group and pushes on one PR no longer cancel in-flight doc builds on another. Thegithub.run_idfallback is unchanged for parity with other workflows.Reviewed by Cursor Bugbot for commit 5adea5a. Bugbot is set up for automated code reviews on this repo. Configure here.