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.

  1. Create a Trunk Account here.
  2. Follow the onboarding flow to create an Organization and install the Trunk Github app.
  3. Select the repository you would like to use and click Get Started.
611611
  1. Navigate to Merge using the navigation pane on the left side of the screen.
  2. Enter the name of the target branch and the number of pull requests that can be tested in parallel.
407407
  1. 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: 0.17.0-beta
merge:
  required_statuses:
    - Trunk Check
    - Unit tests & test coverage
    - Integration tests
  1. 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/.

  2. 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}

544544

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

671671

Did this page help you?