> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.manicule.dev/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://mintlify.manicule.dev/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://mintlify.manicule.dev/api/mcp.
> Every agent surface: https://mintlify.manicule.dev/.well-known/llms-manifest.json

# Configure automerge for GitHub Apps (/guides/configure-automerge)

<!-- agent-signals: reading_time_min: 2 · est_tokens: 559 · updated: 2026-07-31 -->
Related: [Tutorial: Build an in-app documentation assistant](/guides/assistant-embed.md), [Use automations](/guides/use-automations.md), [Write documentation with Claude Code](/guides/claude-code.md), [Write documentation with Codex](/guides/codex.md), [Write documentation with Cursor](/guides/cursor.md), [Write documentation with Devin Desktop](/guides/devin-desktop.md)

> 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](/automations/index) to automatically merge changes to `main`.

<Note>The Mintlify GitHub App must have bypass permissions on **every** ruleset that targets your deploy branch, including rulesets defined at the organization level and the repository level. If any ruleset is missing the bypass entry, the automation creates a PR, but does not merge it.</Note>

## Prerequisites

* Repository admin access (and organization admin access if there are org-level rulesets)
* [Mintlify GitHub App](/deploy/github) installed on the repository
* One or more rulesets targeting the `main` branch (at the org or repo level)

## Steps

Repeat these steps for every ruleset that applies to your deploy branch. Both **organization-level** and **repository-level** rulesets.

<Steps>
  <Step title="Navigate to rulesets">
    * **Repository rulesets**: On GitHub, go to your repository's **Settings** → **Rules** → **Rulesets**.
    * **Organization rulesets**: Go to your organization's **Settings** → **Rules** → **Rulesets**.
  </Step>

<Step title="Select the ruleset">Click a ruleset that targets your deploy branch, which is usually `main`.</Step>

  <Step title="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**.
  </Step>

<Step title="Save">Click **Save changes**.</Step>

<Step title="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.</Step>
</Steps>

## Verify the setup

1. **For contributors**: Open a PR targeting `main`. Confirm that it still requires approval and passing status checks before you can merge.
2. **For automations**: Trigger an automation with automerge enabled. Confirm that the automation runs and successfully merges a PR.