Skip to content

[TRUNK-17692] Document GitHub status posting for merge queue PRs #457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samgutentag wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[TRUNK-17692] Document GitHub status posting for merge queue PRs #457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions merge-queue/administration/advanced-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,21 @@ When enabled, Trunk posts comments on pull requests with merge queue status upda

***

## Post GitHub Status

> Toggle this feature **Enabled** or **Disabled**. Default is **Disabled**.

When enabled, Trunk posts a GitHub commit status on PRs that are in the merge queue. The status appears in the PR's checks section (e.g., `trunk/merge-queue`) and updates as the PR moves through the queue — from waiting, to testing, to merging.

Each status includes a **Details** link that goes directly to the PR's page in the Trunk dashboard. This gives developers visibility into their PR's queue position without leaving GitHub.

**When to enable:**

* **Team adoption** - Makes the merge queue visible in developers' existing GitHub workflow
* **Status-based automation** - Other tools or workflows can react to the `trunk/merge-queue` status

***

## GitHub commands

> Toggle this feature **Enabled** or **Disabled**. Default is **Enabled**.
Expand Down
13 changes: 13 additions & 0 deletions merge-queue/using-the-queue/monitor-queue-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ The Trunk Merge Queue dashboard gives you real-time visibility into your queue's
* Trunk bot comments include dashboard links
* Click any link in bot comments to go directly to that PR's status

#### GitHub commit status

When enabled, Trunk posts a commit status (e.g., `trunk/merge-queue`) on your PR's head commit that shows the current queue state. The status updates as the PR moves through the queue:

* **Waiting in queue** — PR is queued but not yet testing
* **Testing** — PR is actively being tested
* **Merging** — Tests passed, PR is being merged
* **Merged** / **Failed** — Final outcome

Click the **Details** link on the status check to go directly to the Trunk dashboard for that PR.

To enable GitHub commit statuses, go to **Settings** > **Repositories** > your repository > **Merge Queue** and toggle **Post GitHub Status**. This is a per-queue setting and is disabled by default.

### Queue overview

The main dashboard shows a high-level view of your merge queue activity.
Expand Down
Loading