docs(scopes): document the scopes.barrier_files setting#12135
Open
jd wants to merge 1 commit into
Conversation
Contributor
Merge Protections🔴 2 of 6 protections blocking · waiting on 👀 reviews
🔴 👀 Review RequirementsWaiting for
This rule is failing.
🔴 🔎 ReviewsWaiting for
This rule is failing.
Show 4 satisfied protections🟢 🤖 Continuous Integration
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
Pull request overview
Documents the new scopes.barrier_files Merge Queue configuration key and clarifies how the all_scopes (“barrier”) behavior can be produced for both file-pattern scopes and manual scopes.
Changes:
- Fix CLI command reference to
mergify ci scopes-send. - Correct file-pattern scope key names from
includes/excludestoinclude/exclude. - Add and document
scopes.barrier_files, including constraints and queue barrier behavior, and restructure the “impacts every scope” section accordingly.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Document the new `scopes.barrier_files` merge-queue config setting, the config-driven producer of the `all_scopes` barrier flag that the scopes API / `mergify ci scopes-send --all` already set explicitly. Changes to src/content/docs/merge-queue/scopes.mdx: - Add `scopes.barrier_files` to the top-level keys list, alongside `source`, `merge_queue_scope`, and `capacities`. - Restructure "Declaring a pull request impacts every scope" to present both producers of the flag: a new "Barrier files (file-pattern scopes)" subsection for the config-driven path, and "Marking a barrier on upload (manual scopes)" for the existing API/CLI path. The shared "Barrier behavior in the queue" subsection covers the queue semantics for both. - The barrier_files subsection documents the constraints from the engine schema: at least one explicit `include` pattern is required (an empty or exclude-only filter would silently serialize the whole queue, so it is rejected in both the engine and the JSON schema), and it is valid only with a `files` source (a `manual` source reports the flag via the API; a source with no scopes has nothing to impact). Mentions the dashboard "Barrier files" editor in the queue-configuration Scopes section. Also corrects two pre-existing errors on adjacent lines surfaced while documenting the config keys: `mergify scopes-send` -> `mergify ci scopes-send`, and the `files` source description's plural `includes` / `excludes` -> singular `include` / `exclude` (the real key names). MRGFY-8074 Change-Id: I739a941f843840b639abe3028096f27f361f05ab
jd
force-pushed
the
devs/jd/jd/mrgfy-8074-docs-for-featqueue-derive-the-all-scopes-barrier-from-config/document-scopes-barrier-files-setting--739a941f
branch
from
July 17, 2026 10:39
3bdecec to
122af0d
Compare
Member
Author
Revision history
|
jd
commented
Jul 17, 2026
jd
commented
Jul 17, 2026
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.
Document the new
scopes.barrier_filesmerge-queue config setting, theconfig-driven producer of the
all_scopesbarrier flag that the scopesAPI /
mergify ci scopes-send --allalready set explicitly.Changes to src/content/docs/merge-queue/scopes.mdx:
Add
scopes.barrier_filesto the top-level keys list, alongsidesource,merge_queue_scope, andcapacities.Restructure "Declaring a pull request impacts every scope" to present
both producers of the flag: a new "Barrier files (file-pattern scopes)"
subsection for the config-driven path, and "Marking a barrier on upload
(manual scopes)" for the existing API/CLI path. The shared "Barrier
behavior in the queue" subsection covers the queue semantics for both.
The barrier_files subsection documents the constraints from the engine
schema: at least one explicit
includepattern is required (an empty orexclude-only filter would silently serialize the whole queue, so it is
rejected in both the engine and the JSON schema), and it is valid only
with a
filessource (amanualsource reports the flag via the API; asource with no scopes has nothing to impact). Mentions the dashboard
"Barrier files" editor in the queue-configuration Scopes section.
Also corrects two pre-existing errors on adjacent lines surfaced while
documenting the config keys:
mergify scopes-send->mergify ci scopes-send, and thefilessource description's pluralincludes/excludes-> singularinclude/exclude(the real key names).MRGFY-8074