docs(workflow): the fork rebase deprecation is not limited to bot_account - #12718
Conversation
|
This pull request is part of a Mergify stack:
|
Merge Protections🟢 All 6 merge protections satisfied — ready to merge. Show 6 satisfied protections🟢 🤖 Continuous Integration
🟢 👀 Review Requirements
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 Reviews
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
🟡 Changes recommended
The updated deprecation callout’s impersonation fallback wording doesn’t fully match the behavior described in the PR description and should be aligned for technical accuracy.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the rebase action documentation to clarify that the fork-rebase deprecation applies to all fork pull requests (not only when bot_account is configured) and refreshes the page’s worked example to avoid relying on a deprecated option.
Changes:
- Rewords the fork pull-request deprecation callout to remove the misleading
bot_accountscoping. - Replaces the
autosquash-based example with a label-triggered rebase example.
File summaries
| File | Description |
|---|---|
| src/content/docs/workflow/actions/rebase.mdx | Clarifies fork rebase deprecation scope and swaps the example to a non-autosquash configuration. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The Pull Request Dependencies section said a `Depends-On:` header could point at "other repositories with Mergify installed within your organization". The constraint is the same repository *owner*, which may be a user account rather than an organization. A reference to another owner is rendered with a "depends-on conditions must have the same repository owner" warning and never satisfies. The section was also silent on what happens to a reference Mergify cannot resolve — another owner, a repository without Mergify, or a pull request that does not exist. None of those ever reach the `depends-on` attribute, so the condition stays unsatisfied and blocks the merge rather than being skipped, which is the behaviour a reader most needs to be told about. This brings the page in line with the same rules already documented for the `depends-on` merge protection in /merge-protections/builtin, which was corrected and left this page behind. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019V4gXwb2UucysW4xmB7bAw Change-Id: I790b2c0c6e38ed5eff9ac587378765c72939f264
…ount The caution scoped the deprecation to the `rebase` action "with `bot_account`" on fork pull requests. Rebasing always impersonates a GitHub user: when `bot_account` is unset Mergify falls back to the pull request author (or the command sender), and refuses to run when neither resolves. The deprecation notice is posted on any fork rebase, so a reader whose configuration sets no `bot_account` read the caution as not applying to them when it does — the one group the callout most needed to reach. The page's only example was also built on `autosquash`, which the schema marks deprecated, so the single worked example on the page taught the option we are steering people away from. Replaced with a plain label-triggered rebase, matching the "Squash on Label" example on the squash page. Nothing is lost by dropping `autosquash` from the example: the Parameters table still renders its `deprecated` badge from the schema, and Rebase Requirements still documents its effect on the `#commits > 1` disjunct. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019V4gXwb2UucysW4xmB7bAw Change-Id: Ibf1f715b72dbd21e819305a61b27555cf62874c7
0ebd0f9 to
00e4c2f
Compare
Revision history
|
|
Re-pushed to address the review: the deprecation callout now names both impersonation fallbacks — the sender of the Compare: |
Merge Queue Status
This pull request spent 3 minutes 27 seconds in the queue, including 2 minutes 50 seconds running CI. Required conditions to merge
|
The caution scoped the deprecation to the
rebaseaction "withbot_account"on fork pull requests. Rebasing always impersonates a GitHub user: when
bot_accountis unset Mergify falls back to the pull request author (or thecommand sender), and refuses to run when neither resolves. The deprecation
notice is posted on any fork rebase, so a reader whose configuration sets no
bot_accountread the caution as not applying to them when it does — the onegroup the callout most needed to reach.
The page's only example was also built on
autosquash, which the schema marksdeprecated, so the single worked example on the page taught the option we are
steering people away from. Replaced with a plain label-triggered rebase,
matching the "Squash on Label" example on the squash page.
Nothing is lost by dropping
autosquashfrom the example: the Parameterstable still renders its
deprecatedbadge from the schema, and RebaseRequirements still documents its effect on the
#commits > 1disjunct.Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_019V4gXwb2UucysW4xmB7bAw