Skip to content

docs(merge-queue): choose a merge method per pull request - #451

Merged
pv72895 merged 5 commits into
mainfrom
phil/trunk-23090-merge-method-docs
Nov 4, 2026
Merged

pv72895 merged 5 commits into
mainfrom
phil/trunk-23090-merge-method-docs

Conversation

@pv72895

@pv72895 pv72895 commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Part of TRUNK-23090.

Merge after trunk2 #7931 (the web app's merge method menu) is deployed to production. This page describes that menu. Draft until then.

What

Documents choosing a merge method per pull request.

  • merge-queue/administration/advanced-settings.mdx: new section "Choosing a merge method per pull request": the setting (Settings → General, "Allow choosing a merge method per pull request", off by default), choosing from the web app, the /trunk merge --merge-method comment flag and the API, what gets refused, turning it off, and stacks. The queue's dropdown is now named Default merge method, as in the app.
    It also says where a chosen method shows (the submit button, the PR page badge, and Trunk's PR comment) and that a repository refusing the method at merge time removes the PR with the reason.
  • merge-queue/reference/common-problems.mdx: removes "The merge method applies to the entire repository, not on a per-PR basis." and points to the new section.
  • merge-queue/using-the-queue/reference.mdx: the comment flag.
  • merge-queue/using-the-queue/api.mdx: a Merge method section (the config field, submit and queue-entry PATCH, null, read-back, refusals) and a 422 example.
  • openapi-v2.json: re-synced verbatim from trunk2 ts/apps/public-api/openapi-v2.json at main 2ba68ba16 (re-synced 2026-11-04, after trunk2 #7935 added the MERGE_METHOD_NOT_ALLOWED failure reason), the same hand copy as earlier syncs (no automation exists). It is large because the spec had drifted (~1,300 lines ignoring key order); it adds four /v2/tests/{testId}/... operations that docs.json doesn't list, so they stay unpublished.

GitLab is not mentioned, since these docs describe merge queues as GitHub-only. The CLI flag (trunk2 https://github.com/trunk-io/trunk2/pull/7937) isn't documented: docs2 has no page for trunk mergequeue.

🤖 Generated with Claude Code

pv72895 and others added 3 commits November 3, 2026 18:46
Documents the "Allow choosing a merge method per pull request" setting,
the /trunk merge --merge-method flag, the API's mergeMethod field and the
GitLab wording, and drops the note that the merge method applies to the
whole repository.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Verbatim copy of trunk2 ts/apps/public-api/openapi-v2.json at origin/main
071a40ab9. Picks up isMergeMethodOverrideEnabled on the queue config,
mergeMethod on submit and the queue-entry PATCH, and queueEntry.mergeMethod.
GET/DELETE /v2/tests/{testId}/ticket and the two GET
/v2/tests/{testId}/investigations operations are in the spec but not in the
nav, so they aren't published.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
trunk 🟢 Ready View Preview Nov 4, 2026, 3:09 PM

…ge; re-sync the v2 spec

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…nd refusal behaviour exactly

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pv72895
pv72895 marked this pull request as ready for review November 4, 2026 15:10
@pv72895
pv72895 merged commit c1e446e into main Nov 4, 2026
4 checks passed
@mintlify

mintlify Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Docs PR opened: #457

Added a Merge Queue changelog post about choosing a merge method per pull request, listed on both changelog pages.

This branch was successfully deployed

1 active deployment
staging — c187877d Deployed Nov 4, 2026 by mintlify[bot]
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.

1 participant