Mergify Documentation

Ship faster with healthier CI, safer merges, and powerful workflow automation.

CI Insights

Insights & automation to make your test suite lean and reliable.

Overview

What CI Insights gives you.

Flaky Test Detection

Surface inconsistent tests & jobs.

Auto‑Retry

Automatic transient failure retries.

Quarantine

Isolate noisy tests to unblock merges.

Test Frameworks

Configure report upload.

Merge Queue

Deterministic, parallel, and resource‑aware merging.

Introduction

Core concepts & guarantees.

Setup

Enable & configure your first queue.

Queue Rules

Route PRs & define policies.

Lifecycle

From enqueue to merge.

Priority

Order critical work first.

Parallel Checks

Batch compatible PR tests.

Performance

Throughput & optimization tips.

Batches

Increase velocity with batches.

Two‑Step CI

Fast + full validation strategy.

Deployment

Adopt safely in production.

Monitoring

Key metrics & dashboards.

Troubleshooting

Solve common issues.

Merge Protections

Advanced guardrails before code lands.

Overview

Protection capabilities.

Setup

Enable and mark check required.

Built‑in Protections

Depends-On, Merge-After, config safety.

Custom Rules

Define granular success logic.

Freezes

Schedule or trigger merge freezes.

Examples

Common rule recipes.

Workflow Automation

Expressive rule engine & rich actions to eliminate manual toil.

Overview

What you can automate.

First Rule

Create your first automation.

Actions

Full action catalog.

Automatic Merge

Merge when policy satisfied.

Request Reviews

Smart reviewer assignment.

Dismiss Reviews

Invalidate outdated approvals.

Delete Branches

Keep repo tidy automatically.

Rebase PRs

Keep branches current.

Reference & Platform

Configuration File

YAML structure & semantics.

Conditions

Filter syntax details.

Data Types

All supported value kinds.

Sharing Configuration

Reuse config across repos.

Commands

ChatOps style commands.

API Usage

Authenticate & call the API.

API Reference

Endpoint reference.

Integrations

CI & ecosystem hooks.

Stacks

Stacked PR workflow.

Badge

Public project badge.

Security

Security & permissions.

Billing

Plans & billing model.

Join our Community 💬

Share feedback, ask questions, and see what other teams build with Mergify.