Configure automerge for GitHub Apps
Set up GitHub workflows to automatically merge Mintlify pull requests by adding the Mintlify bot to your repository's ruleset bypass list.
Add the Mintlify GitHub App to a ruleset's bypass list so that the app can create and merge pull requests without review and status check requirements blocking it. This lets you configure automations to automatically merge changes to main.
Prerequisites
Section titled “Prerequisites”- Repository admin access (and organization admin access if there are org-level rulesets)
- Mintlify GitHub App installed on the repository
- One or more rulesets targeting the
mainbranch (at the org or repo level)
Repeat these steps for every ruleset that applies to your deploy branch. Both organization-level and repository-level rulesets.
Select the ruleset
Click a ruleset that targets your deploy branch, which is usually
main.Add the Mintlify GitHub App to the bypass list
- Under Bypass list, click Add bypass.
- Search for and select the Mintlify GitHub App.
- Set the bypass mode to Always.
Save
Click Save changes.
Repeat for remaining rulesets
If you have additional rulesets at the org or repo level that target your deploy branch, repeat steps 2–4 for each one.
Verify the setup
Section titled “Verify the setup”- For contributors: Open a PR targeting
main. Confirm that it still requires approval and passing status checks before you can merge. - For automations: Trigger an automation with automerge enabled. Confirm that the automation runs and successfully merges a PR.