Skip to content

docs: document unified merge queue bot_account#12140

Open
jd wants to merge 1 commit into
mainfrom
devs/jd/jd/bot-account-docs/rename-queue-key-draft-bot-account-bot-account--4e705e37
Open

docs: document unified merge queue bot_account#12140
jd wants to merge 1 commit into
mainfrom
devs/jd/jd/bot-account-docs/rename-queue-key-draft-bot-account-bot-account--4e705e37

Conversation

@jd

@jd jd commented Jul 17, 2026

Copy link
Copy Markdown
Member

Mergify unifies the three per-operation merge-queue bot accounts —
draft_bot_account, merge_bot_account, and update_bot_account — into a
single bot_account key (Mergifyio/monorepo#37097). This drops per-operation
account granularity: one account now performs every queue operation (creating
draft pull requests, updating branches, merging).

Update the docs to match:

  • configuration/data-types.mdx — rewrite the "Bot account" section to describe
    the single unified key and add a dateless deprecation-alias note: the three
    old keys are deprecated aliases that map to bot_account, and on conflicting
    values a defined precedence wins (merge_bot_account > update_bot_account >
    draft_bot_account) with a warning.
  • merge-queue/merge-strategies.mdx, merge-queue/batches.mdx — replace the
    remaining update_bot_account example/prose references with bot_account.

Left untouched on purpose: the auto-generated schemas
(public/mergify-configuration-schema.json, public/api-schemas.json) are
regenerated externally from the monorepo, and the historical changelog entries
record their original features. The public changelog is synced from the
monorepo, so the unification announcement lands there, not in this repo.

Depends-On: https://github.com/Mergifyio/monorepo/pull/37097

Copilot AI review requested due to automatic review settings July 17, 2026 14:19
@mergify
mergify Bot had a problem deploying to Mergify Merge Protections July 17, 2026 14:19 Failure
@mergify

mergify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🔴 1 of 7 protections blocking · waiting on ⛓️ dependency

Protection Waiting on
🔴 ⛓️ Depends-On Requirements ⛓️ dependency
🟢 🤖 Continuous Integration
🟢 👀 Review Requirements
🟢 Enforce conventional commit
🟢 🔎 Reviews
🟢 📕 PR description
🟢 🚦 Auto-queue

🔴 ⛓️ Depends-On Requirements

Waiting for

  • depends-on = Mergifyio/monorepo#37097 [⛓️ Mergifyio/monorepo#37097]
This rule is failing.

Requirement based on the presence of Depends-On in the body of the pull request

  • depends-on = Mergifyio/monorepo#37097 [⛓️ Mergifyio/monorepo#37097]

Show 6 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/

🟢 👀 Review Requirements

  • any of:
    • #approved-reviews-by >= 2
    • author = dependabot[bot]
    • author = mergify-ci-bot

🟢 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)(?:\(.+\))?!?:

🟢 🔎 Reviews

  • #changes-requested-reviews-by = 0
  • #review-requested = 0
  • #review-threads-unresolved = 0

🟢 📕 PR description

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

🟢 🚦 Auto-queue

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

@mergify
mergify Bot requested a review from a team July 17, 2026 14:21

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

Updates the Mergify docs’ “Bot account” data type reference to reflect the merge queue configuration key rename from draft_bot_account to bot_account, while keeping the former name discoverable for readers migrating existing configs.

Changes:

  • Replaces the merge queue key reference draft_bot_account with bot_account.
  • Adds a parenthetical note to indicate the former key name (draft_bot_account) for migration recognition.

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

@jd
jd marked this pull request as ready for review July 17, 2026 15:01
@jd jd changed the title docs: rename queue key draft_bot_account to bot_account docs: document unified merge queue bot_account Jul 17, 2026
@jd
jd force-pushed the devs/jd/jd/bot-account-docs/rename-queue-key-draft-bot-account-bot-account--4e705e37 branch from 8a88b6d to 71064a2 Compare July 17, 2026 15:13
@jd

jd commented Jul 17, 2026

Copy link
Copy Markdown
Member Author

Revision history

# Type Changes Reason Date
1 initial 8a88b6d 2026-07-17 15:13 UTC
2 content 8a88b6d → 71064a2 (raw) 2026-07-17 15:13 UTC
3 content 71064a2 → 1d1db24 (raw) address review (jd): drop the deprecated-alias / precedence prose for the former per-op keys; document bot_account only 2026-07-17 16:22 UTC

@mergify
mergify Bot had a problem deploying to Mergify Merge Protections July 17, 2026 15:14 Failure
@jd
jd marked this pull request as draft July 17, 2026 15:16
Comment thread src/content/docs/configuration/data-types.mdx Outdated
Mergify unifies the three per-operation merge-queue bot accounts —
`draft_bot_account`, `merge_bot_account`, and `update_bot_account` — into a
single `bot_account` key (Mergifyio/monorepo#37097). This drops per-operation
account granularity: one account now performs every queue operation (creating
draft pull requests, updating branches, merging).

Update the docs to match:
- configuration/data-types.mdx — rewrite the "Bot account" section to describe
  the single unified key and add a dateless deprecation-alias note: the three
  old keys are deprecated aliases that map to `bot_account`, and on conflicting
  values a defined precedence wins (`merge_bot_account` > `update_bot_account` >
  `draft_bot_account`) with a warning.
- merge-queue/merge-strategies.mdx, merge-queue/batches.mdx — replace the
  remaining `update_bot_account` example/prose references with `bot_account`.

Left untouched on purpose: the auto-generated schemas
(public/mergify-configuration-schema.json, public/api-schemas.json) are
regenerated externally from the monorepo, and the historical changelog entries
record their original features. The public changelog is synced from the
monorepo, so the unification announcement lands there, not in this repo.

Depends-On: Mergifyio/monorepo#37097

Change-Id: I4e705e37b673210b1d5f4d04a0411d2c8e8c6f94
@jd
jd force-pushed the devs/jd/jd/bot-account-docs/rename-queue-key-draft-bot-account-bot-account--4e705e37 branch from 71064a2 to 1d1db24 Compare July 17, 2026 16:22
@mergify
mergify Bot requested a deployment to Mergify Merge Protections July 17, 2026 16:22 In progress
@jd
jd marked this pull request as ready for review July 20, 2026 17:24
@mergify
mergify Bot requested a review from a team July 20, 2026 19:54
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.

4 participants