Skip to content

docs(merge-queue): show classic branch protection path for exclusive mode#12190

Open
jd wants to merge 1 commit into
mainfrom
devs/jd/jd/merge-queue-shots/show-classic-branch-protection-path-exclusive-mode--5c33dfa7
Open

docs(merge-queue): show classic branch protection path for exclusive mode#12190
jd wants to merge 1 commit into
mainfrom
devs/jd/jd/merge-queue-shots/show-classic-branch-protection-path-exclusive-mode--5c33dfa7

Conversation

@jd

@jd jd commented Jul 22, 2026

Copy link
Copy Markdown
Member

Wire the two orphaned screenshots in deploy/ (bp-settings.png, bp-rule.png)
into the "Approach 2: Exclusive Mode" section of merge-queue/deploy.mdx.

The exclusive-mode steps previously said "follow the on-screen instructions"
and "click the verification button" without showing the GitHub UI. These two
screenshots document the classic branch-protection way to enforce exclusive
mode: restrict who can push to the protected branch to the Mergify app only.

They are added as a clearly-labeled "Enforcing Exclusive Mode with Classic
Branch Protection" alternative, NOT mixed into the recommended ruleset +
bypass-list flow (which the dashboard actively recommends and which the fresh
deploy/dashboard.png already illustrates). Classic branch protection is a
supported, already-documented path elsewhere in these docs (batches.mdx,
merge-strategies.mdx).

Judgment call for review: the orphaned bp-* assets document classic branch
protection while the current section documents the ruleset flow. If the intent
is for deploy.mdx to stay ruleset-only, drop this commit and the bp-* images
become deletion candidates.

Part 3 (Merge Queue) of the docs screenshot refresh. The other Part 3 items
resolved without a diff: all 7 freshness-verify pages (batches, lifecycle,
merge-strategies, monitoring, pause, setup, deploy) show the current dashboard
/ GitHub UI -> OK, no re-capture; and the github-rulesets.mdx bypass-actor
capture was declined (GitHub's own UI, already a clear textual click-through).

Proofreading: the mandated 4-agent proofread pipeline (style, technical,
structure, consistency) was run this session and passed clean; one precision
fix was applied to the closing sentence.

Refs: MRGFY-8060

…mode

Wire the two orphaned screenshots in deploy/ (bp-settings.png, bp-rule.png)
into the "Approach 2: Exclusive Mode" section of merge-queue/deploy.mdx.

The exclusive-mode steps previously said "follow the on-screen instructions"
and "click the verification button" without showing the GitHub UI. These two
screenshots document the classic branch-protection way to enforce exclusive
mode: restrict who can push to the protected branch to the Mergify app only.

They are added as a clearly-labeled "Enforcing Exclusive Mode with Classic
Branch Protection" alternative, NOT mixed into the recommended ruleset +
bypass-list flow (which the dashboard actively recommends and which the fresh
deploy/dashboard.png already illustrates). Classic branch protection is a
supported, already-documented path elsewhere in these docs (batches.mdx,
merge-strategies.mdx).

Judgment call for review: the orphaned bp-* assets document classic branch
protection while the current section documents the ruleset flow. If the intent
is for deploy.mdx to stay ruleset-only, drop this commit and the bp-* images
become deletion candidates.

Part 3 (Merge Queue) of the docs screenshot refresh. The other Part 3 items
resolved without a diff: all 7 freshness-verify pages (batches, lifecycle,
merge-strategies, monitoring, pause, setup, deploy) show the current dashboard
/ GitHub UI -> OK, no re-capture; and the github-rulesets.mdx bypass-actor
capture was declined (GitHub's own UI, already a clear textual click-through).

Proofreading: the mandated 4-agent proofread pipeline (style, technical,
structure, consistency) was run this session and passed clean; one precision
fix was applied to the closing sentence.

Refs: MRGFY-8060
Change-Id: I5c33dfa7d7a144b27cea064f0bf4ec9f64148719
Copilot AI review requested due to automatic review settings July 22, 2026 17:12
@mergify
mergify Bot had a problem deploying to Mergify Merge Protections July 22, 2026 17:12 Failure
@mergify

mergify Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🔴 2 of 6 protections blocking · waiting on 👀 reviews

Protection Waiting on
🔴 👀 Review Requirements 👀 reviews
🔴 🔎 Reviews 👀 reviews
🟢 🤖 Continuous Integration
🟢 Enforce conventional commit
🟢 📕 PR description
🟢 🚦 Auto-queue

🔴 👀 Review Requirements

Waiting for

  • #approved-reviews-by >= 2
This rule is failing.
  • any of:
    • #approved-reviews-by >= 2
    • author = dependabot[bot]
    • author = mergify-ci-bot

🔴 🔎 Reviews

Waiting for

  • #review-requested = 0
This rule is failing.
  • #review-requested = 0
  • #changes-requested-reviews-by = 0
  • #review-threads-unresolved = 0

Show 4 satisfied protections

🟢 🤖 Continuous Integration

  • all of:
    • check-success = build
    • check-success = lint
    • check-success = test
    • any of:
      • check-success = test-broken-links
      • label = ignore-broken-links
    • any of:
      • check-success=Cloudflare Pages
      • -head-repo-full-name~=^Mergifyio/

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|internal|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?!?:

🟢 📕 PR description

  • body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the Merge Queue deployment documentation to include a clearly separated “classic branch protection” path for enforcing Exclusive Mode, wiring in two previously orphaned screenshots so readers can follow the GitHub UI steps.

Changes:

  • Import and use two GitHub branch protection screenshots (bp-settings.png, bp-rule.png) in merge-queue/deploy.mdx.
  • Add a new subsection describing how to enforce Exclusive Mode using classic branch protection (restrict push access to the Mergify app).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/content/docs/merge-queue/deploy.mdx
@mergify
mergify Bot requested a review from a team July 22, 2026 17:15
@jd
jd marked this pull request as ready for review July 25, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants