docs(merge-queue): document serial-mode batch grouping heuristic#11693
Merged
Conversation
Contributor
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 🤖 Continuous IntegrationWonderful, this rule succeeded.
🟢 👀 Review RequirementsWonderful, this rule succeeded.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 ReviewsWonderful, this rule succeeded.
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
There was a problem hiding this comment.
Pull request overview
Documents the updated serial-mode batch grouping heuristic in the Merge Queue “Batches” documentation, clarifying how Mergify chooses which pull requests share a batch and removing a vague/incorrect note from the failure-handling section.
Changes:
- Add a new section explaining batch composition rules (priority/queue order, similarity via scopes or changed directories, and stack co-location).
- Provide an illustrative DOT diagram and a note about
batch_max_wait_timeaffecting candidate availability. - Remove the previous note in the failure-handling section that gave an incomplete description of batching behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sileht
force-pushed
the
devs/sileht/mrgfy-7456-document-serial-mode-batch-grouping/document-serial-mode-batch-grouping-heuristic--a6adeea3
branch
from
39926da to
b3b9cca
Compare
Member
Author
Revision history
|
jd
previously approved these changes
Jun 1, 2026
sileht
commented
Jun 1, 2026
sileht
force-pushed
the
devs/sileht/mrgfy-7456-document-serial-mode-batch-grouping/document-serial-mode-batch-grouping-heuristic--a6adeea3
branch
from
b3b9cca to
208ba38
Compare
The heuristic that groups pull requests into batches in serial mode was changed in #32298 (group by changed-directory similarity when no scopes source is configured) and was undocumented. Document, in the Batches page, how Mergify decides which pull requests share a batch: priority and queue order come first, then similarity fills the batch (scopes when configured, otherwise the directories each PR changes), and stacks are kept together. Replace the vague, out-of-place note in the failure-handling section with this accurate description. Fixes MRGFY-7456 Change-Id: Ia6adeea393375646d6c530dc85e560339e81a9a3
sileht
force-pushed
the
devs/sileht/mrgfy-7456-document-serial-mode-batch-grouping/document-serial-mode-batch-grouping-heuristic--a6adeea3
branch
from
208ba38 to
c100266
Compare
JulianMaurin
approved these changes
Jun 2, 2026
kozlek
approved these changes
Jun 2, 2026
Contributor
Merge Queue Status
This pull request spent 2 minutes 9 seconds in the queue, including 1 minute 42 seconds running CI. Required conditions to merge
|
51 tasks
mergify
Bot
deleted the
devs/sileht/mrgfy-7456-document-serial-mode-batch-grouping/document-serial-mode-batch-grouping-heuristic--a6adeea3
branch
sileht
added a commit
that referenced
this pull request
Jun 2, 2026
…atching The batch-grouping section listed priority, scopes, changed directories, and queue time as the similarity ranking, then described stacks in a separate paragraph that read as a fifth tier of that order. Readers (jd on PR #11693) took it as "scope -> files -> stack" and expected stack to come before files. Reframe the stack rule to match the engine: in serial mode stack co-location is a separate constraint outside the similarity ranking (_add_pull_with_predecessors), not a ranking tier. Selected pull requests drag their queued predecessors into the same batch regardless of scope or directory overlap, so stack relationships take precedence over scope and directory similarity, bounded only by batch_size. Also repoint the stale parallel-scopes link to queue-modes#parallel-mode. Fixes MRGFY-7466 Change-Id: I8a0172f86b0629e0086e51c038e0244339086447
mergify Bot
pushed a commit
that referenced
this pull request
Jun 2, 2026
…atching (#11702) The batch-grouping section listed priority, scopes, changed directories, and queue time as the similarity ranking, then described stacks in a separate paragraph that read as a fifth tier of that order. Readers (jd on PR #11693) took it as "scope -> files -> stack" and expected stack to come before files. Reframe the stack rule to match the engine: in serial mode stack co-location is a separate constraint outside the similarity ranking (_add_pull_with_predecessors), not a ranking tier. Selected pull requests drag their queued predecessors into the same batch regardless of scope or directory overlap, so stack relationships take precedence over scope and directory similarity, bounded only by batch_size. Also repoint the stale parallel-scopes link to queue-modes#parallel-mode. Fixes MRGFY-7466
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.
The heuristic that groups pull requests into batches in serial mode was
changed in #32298 (group by changed-directory similarity when no scopes
source is configured) and was undocumented.
Document, in the Batches page, how Mergify decides which pull requests
share a batch: priority and queue order come first, then similarity
fills the batch (scopes when configured, otherwise the directories each
PR changes), and stacks are kept together. Replace the vague,
out-of-place note in the failure-handling section with this accurate
description.
Fixes MRGFY-7456