Migrate from GitHub Merge Queue

For teams switching from GitHub Merge Queues to Trunk Merge Queue, the process is straight forward.

Looking for a more detailed comparison between Trunk and GitHub's Merge Queues? Learn more

---

Turn off GitHub Merge Queue

To start, you will need to disable the exising merge queue for the target repository. This can be done by navigating to the repository and opening Settings > Branches > branch rule > toggle off Require merge queue. Be sure to click Save changes to confirm the settings.

Note that only users with admin permissions can manage merge queues for pull requests targeting selected branches of a repository. More information on manage merge queues can be found in the GitHub documentation.

---

Enable Trunk Merge Queue

Follow the Getting Started to setup your repo with Trunk Merge Queue and configure the settings for your repository.

---

Running both merge queues simultaneously

Many teams prefer a gradual migration approach where Trunk Merge Queue runs alongside GitHub Merge Queue before fully switching over. This is a common path for teams migrating from GitHub's merge queue to Trunk and works well for several reasons:

No Disruption to Existing Workflows

Enabling Trunk Merge Queue does not stop or prevent your current merging flow. GitHub's merge queue will continue to function normally and merge PRs as it always has. Your team can continue using their familiar workflow while you evaluate Trunk Merge Queue.

Disable Comments During Evaluation

To prevent confusion for developers who aren't yet aware of the migration, you can disable the comments Trunk leaves on PRs. This way, developers won't see unfamiliar comments about Trunk Merge Queue while you're still evaluating.

This setting is found under Merge Queue tab > repository > Settings > toggle off GitHub Comments.

Trunk Handles External Merges Gracefully

Trunk Merge Queue understands when a PR is merged outside of its queue (for example, through GitHub's merge queue):

• If the PR is also in Trunk's queue: Trunk will automatically mark it as merged on its side.

• If the PR is not in Trunk's queue: Trunk will restart any PRs currently in its queue so they can test on top of the new commit.

This ensures that Trunk always tests against the latest state of your target branch, regardless of how PRs are merged.

---

Pre migration

Before migrating fully, it may be useful to evaluate the workflows "quiety" and confirm settings before converting your repository to an entirely new workflow.

Here are some useful steps to get you familiar with the Trunk Merge Queue workflow without disrupting engineers.

Enable Trunk Merge for testing but with the automatic comments disabled

While evaluating and testing Trunk Merge Queue for your team, we suggest disabling automatic comments on PRs. This can be done by toggling off GitHub Comments in the Trunk web app.

This setting is found under Merge Queue tab > repository > Settings > toggle off GitHub Comments.

Make the switch

Once you have configured settings and tested out the workflow quietly, turn off other merge tools (like GitHub merge queue), re-enable GitHub comments in the Trunk web app under the Merge Queue tab > repository > Settings > toggle on GitHub Comments

It is important that a repository is configured to use ONLY Trunk Merge Queue and no other merge queue tools for best results.

Share the news

Now that you have migrated to Trunk Merge Queue, be sure to share the workflow with your team, Using the Queueas a great place to start.

---

Getting help

If you or your team are running into issues be sure to join the Trunk Slack community for assistance.