Configure automerge for GitHub Apps

Add a GitHub App to a ruleset bypass list to enable automatic merging for workflows.

Add the Mintlify GitHub App to a ruleset’s bypass list so that the app can create and merge pull requests without being blocked by review and status check requirements. This allows you to configure workflows to automatically merge changes to main.

Prerequisites

• Repository admin access
• Mintlify GitHub App installed on the repository
• An existing ruleset targeting the main branch

Steps

1. Navigate to rulesets

   On GitHub, go to Settings -> Rules -> Rulesets in your repository.

2. Select the ruleset

   Click the ruleset that targets your main branch.

   If multiple rulesets target main, the app must be on the bypass list of every active ruleset.

3. Add the Mintlify GitHub App to the bypass list

   1. Under Bypass list, click Add bypass.
   2. Search for and select the Mintlify GitHub App.
   3. Set the bypass mode to Always.
4. Save

   Click Save changes.

Verify the setup

1. For contributors: Open a PR targeting main. Confirm that it still requires approval and passing status checks before the merge button is enabled.
2. For workflows: Trigger a workflow with automerge enabled. Confirm that the workflow runs and successfully merges a PR.