Getting Started
Get started with Trunk Merge in just a few minutes
This setup guide will walk you through the initial setup for Trunk Merge.
- Create a Trunk Account here.
- Follow the onboarding flow to create an Organization and install the Trunk Github app.
- Select the repository you would like to use and click Get Started.

- Navigate to Merge using the navigation pane on the left side of the screen.
- Enter the name of the target branch and the number of pull requests that can be tested in parallel.

- Merge uses GitHub status checks to determine whether a pull request can be merged. Configure these checks by adding them to the
trunk.yaml
configuration file in your repository:
version: 0.1
cli:
version: 1.1.0
merge:
required_statuses:
- Trunk Check
- Unit tests & test coverage
- Integration tests
-
Set up the required checks by configuring your CI provider to run the required jobs whenever a branch is pushed to your GitHub repository with the special prefix
trunk-merge/
. -
Submit a pull request, either using the Trunk CLI or in the GitHub Pull Request UI
With the Trunk CLI: after authenticating the CLI by running $ trunk login
, run the command trunk merge {pr-number}

GitHub Pull Request UI: Comment /trunk merge
on a pull request

Updated 7 months ago