[feature not live] docs(merge-queue): document configurable label commands for enqueueing#659
[feature not live] docs(merge-queue): document configurable label commands for enqueueing#659samgutentag wants to merge 1 commit into
Conversation
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>
|
Merging to
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 finished @samgutentag's task in 1m 45s —— View job Claude Code Review
SummaryReviewed the 27 lines added to
None of these are blocking; they are all style/consistency suggestions on otherwise-correct content. |
| trunk merge cancel <pr-number> | ||
| ``` | ||
|
|
||
| * Removing the configured enqueueing label from a pull request (when label commands are enabled). |
There was a problem hiding this comment.
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:
| * 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). |
| ## 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 |
There was a problem hiding this comment.
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:
| ## 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.)
| | 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 | |
There was a problem hiding this comment.
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.
| | 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. |
There was a problem hiding this comment.
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.
Summary
Source
Test plan
Generated by Claude Code