Skip to content

[feature not live] docs(merge-queue): document configurable label commands for enqueueing#659

Draft
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/mq-configurable-enqueue-label
Draft

[feature not live] docs(merge-queue): document configurable label commands for enqueueing#659
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/mq-configurable-enqueue-label

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Documents the new Label Commands setting in Merge Queue Settings
  • Explains how to enable label-based enqueue/cancel and configure the label name
  • Adds a new "Label Commands" section to the Submit and Cancel PR reference page

Source

Test plan

  • Preview in GitBook
  • Verify label table renders correctly

Generated by Claude Code

Documents the new Label Commands setting in Merge Queue that lets teams
enqueue and cancel PRs by applying or removing a configured GitHub label.
Covers how to enable the setting, configure the label name, and how label
apply/remove maps to queue submit/cancel actions.

Source: trunk-io/trunk2#3956

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 14, 2026

Claude finished @samgutentag's task in 1m 45s —— View job


Claude Code Review

  • Read changed files
  • Check related docs for style consistency
  • Review for typos, grammar, and formatting
  • Post inline review feedback

Summary

Reviewed the 27 lines added to merge-queue/using-the-queue/reference.md. Overall the content is clear, well-organized, and follows the existing structure of the page. No typos or grammatical errors found. Posted 4 inline comments covering minor consistency issues:

  1. [Line 41] Cancellation bullet should mirror line 23 by linking to the #label-commands anchor.
  2. [Lines 72/76] Heading capitalization — rest of the page uses sentence case (Custom merge commit titles, Pull request processing); new headings mix Title Case (Label Commands, Enabling Label Commands) with sentence case (How it works). Recommend sentence case throughout for the page-level style; keep Label Commands capitalized in body prose where it names the UI setting.
  3. [Lines 86–87] Adjacent table rows say Merge Queue (row 1) and queue (row 2) — pick one.
  4. [Line 89] Nit — the "label must already exist" callout reads as a gotcha and could be a {% hint style="warning" %} to match the existing hint pattern below it.

None of these are blocking; they are all style/consistency suggestions on otherwise-correct content.
· Branch

trunk merge cancel <pr-number>
```

* Removing the configured enqueueing label from a pull request (when label commands are enabled).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor consistency: the parallel bullet on line 23 links readers to the [Label Commands](#label-commands) section, but this bullet only says "(when label commands are enabled)" without the same anchor link. For users skimming the cancellation list, the link is just as useful. Consider mirroring line 23:

Suggested change
* Removing the configured enqueueing label from a pull request (when label commands are enabled).
* Removing the configured enqueueing label from a pull request (when label commands are enabled — see [Label Commands](#label-commands) below).

Comment on lines +72 to +76
## Label Commands

Label Commands let you enqueue and cancel PRs in the Merge Queue by applying or removing a GitHub label, without leaving a comment or using the CLI.

### Enabling Label Commands
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Heading capitalization is inconsistent with the rest of the page.

Every other ##/### heading on this page uses sentence case (e.g. ## Submitting and cancelling pull requests, ## Custom merge commit titles, ## Pull request processing, ## Pull request states, ### Example). The new section uses Title Case for ## Label Commands and ### Enabling Label Commands, but then drops back to sentence case for ### How it works — so it's also internally inconsistent.

Recommend sentence case throughout to match the rest of the page:

Suggested change
## Label Commands
Label Commands let you enqueue and cancel PRs in the Merge Queue by applying or removing a GitHub label, without leaving a comment or using the CLI.
### Enabling Label Commands
## Label commands
Label Commands let you enqueue and cancel PRs in the Merge Queue by applying or removing a GitHub label, without leaving a comment or using the CLI.
### Enabling label commands

(You can keep "Label Commands" capitalized in body prose where it refers to the setting name in the UI — the recommendation is just about heading style.)

Comment on lines +86 to +87
| Apply the enqueueing label to a PR | Submits the PR to the Merge Queue |
| Remove the enqueueing label from a PR | Cancels the PR from the queue |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Inconsistent terminology within adjacent rows: the "Submit" row says "Merge Queue" (capitalized) and the "Cancel" row says "queue" (lowercase, no "Merge"). Pick one for both rows.

Suggested change
| Apply the enqueueing label to a PR | Submits the PR to the Merge Queue |
| Remove the enqueueing label from a PR | Cancels the PR from the queue |
| Apply the enqueueing label to a PR | Submits the PR to the Merge Queue |
| Remove the enqueueing label from a PR | Cancels the PR from the Merge Queue |

| Apply the enqueueing label to a PR | Submits the PR to the Merge Queue |
| Remove the enqueueing label from a PR | Cancels the PR from the queue |

The label must already exist in your GitHub repository. Trunk does not create the label automatically.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: This is an important "gotcha" — if the label doesn't exist, nothing happens. It would stand out more (and match the pattern used for the existing info hint below) if wrapped in a warning hint:

{% hint style="warning" %}
The label must already exist in your GitHub repository. Trunk does not create the label automatically.
{% endhint %}

Non-blocking — leaving as a plain paragraph is also fine.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

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