docs: expand automerge setup requirements#5822
Open
mintlify[bot] wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The dashboard now surfaces an automerge setup banner on the Workflows page that detects when a connected GitHub repository is missing one of the requirements for automerge to actually merge a PR. The banner flags three states: squash merging is disabled on the repository, branch rules require reviews without a Mintlify GitHub App bypass, or an automerge run produced a PR that has not yet merged. Each state links to the GitHub setting that resolves it.
Previously the configure automerge guide only covered ruleset bypass. This PR expands the guide so the prerequisites match what the banner checks for, helping users self-serve when they see it.
Changes
Note
Low Risk
Documentation-only updates that clarify required GitHub settings; no product logic or APIs are changed.
Overview
Updates the
configure-automergeguide (EN/ES/FR/ZH) to reflect two prerequisites for Mintlify automerge: enablingsquash mergeand granting the Mintlify GitHub App bypass access on all applicable branch rules.Adds step-by-step instructions for enabling squash merging, documents bypass setup for both rulesets and classic branch protection rules, and updates the verification section to reference the dashboard’s automerge setup banner.
Reviewed by Cursor Bugbot for commit 37616ef. Bugbot is set up for automated code reviews on this repo. Configure here.