[feature not live] docs(merge-queue): document configurable label commands for enqueueing#661
[feature not live] docs(merge-queue): document configurable label commands for enqueueing#661samgutentag wants to merge 1 commit into
Conversation
Documents the Label Commands setting (trunk2 PR #3956, ships in v175): - enqueueing by label as a submission method - how to enable and configure the enqueueing label in Settings - the apply/remove behavior table https://github.com/trunk-io/trunk2/pull/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 41s —— View job Review summary
Result: non-blocking. The new content is clear, accurate, and well-placed. I left 4 inline comments — all polish, none required to ship. Findings
Things that look good
|
| ## 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 case inconsistent with rest of file. Every other ## and ### heading in reference.md uses sentence case (## Submitting and cancelling pull requests, ## Custom merge commit titles, ### How it works, ### Example), but the new headings use Title Case. Consider matching the file's existing convention:
| ## 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 |
If you do this, also lowercase "Label Commands" in prose on lines 49 and 51 (and the link text on line 23) so the term is treated consistently as a feature description rather than a proper noun.
| 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.
Missing cross-reference for parallelism with line 23. The submission bullet (line 23) helpfully links to the Label Commands section, but the matching cancellation bullet here doesn't. A reader who lands on the cancellation list first won't know where to learn more. Suggest mirroring the submission bullet:
| * 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 are configured per merge queue instance in **Merge Queue Settings** > **Label Commands**. Only organization admins can change this setting. | ||
|
|
||
| When Label Commands are enabled, you can configure the enqueueing label name. The default label is `trunk-merge-queue-submit`. |
There was a problem hiding this comment.
Vague on where to configure the label name. "You can configure the enqueueing label name" implies a setting somewhere, but doesn't say where. Is it the same Merge Queue Settings > Label Commands location mentioned in the previous sentence, or somewhere else? Consider making it explicit, e.g.:
When enabled, you can set a custom label name in the same panel. The default is
trunk-merge-queue-submit.
Also worth confirming whether changing the label name applies retroactively (do PRs already carrying the old label get cancelled? does it require a label to exist beforehand, per line 60?). If there's a known answer, surfacing it here would save a support ticket.
| | 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.
Consider promoting to a warning callout for visibility. This is a precondition that, if missed, will silently break the feature — users may assume Trunk creates the label and wonder why nothing happens when they apply it. The next paragraph is already a {% hint style="info" %}, so the contrast in style suggests this line is less important than it actually is. Suggest:
| The label must already exist in your GitHub repository. Trunk does not create the label automatically. | |
| {% hint style="warning" %} | |
| The label must already exist in your GitHub repository. Trunk does not create the label automatically. | |
| {% endhint %} |
Adds documentation for the Label Commands feature (trunk2 PR #3956, shipped in v175).
Changes
Context
sam-gutentag/mq-configurable-enqueue-labelbranch (PR [feature not live] docs(merge-queue): document configurable label commands for enqueueing #659) which had conflicting changes from before main was updated. This branch starts from current main with only the reference.md change.Generated by Claude Code