Mergify| Docs

Mergify Documentation

Explore & learn Mergify

Welcome to Mergify Documentation. Explore our guides and examples on how to integrate Mergify.

Workflow Automation

Automate your GitHub pull requests workflow.

Getting Started

Learn how to deploy Mergify on your repositories.

Writing Your First Rule

Write your first automation rule using Mergify workflow automation.


A complete list of actions you can use with Mergify.

Workflow Automation Use Cases

Discover a list of use cases that you can leverage with Mergify. Get inspired and adapt it to your own needs.

Automatic Merge

Merge your pull requests as soon as they are ready.

Merge Queue

Getting Started

Learn how to deploy Mergify on your repositories.

Introduction to Merge Queues

Understand what merge queues are and how to use them.

Setting Up Your First Merge Queue

Implement your first merge queue.

Pull Request Lifecycle

Understand the lifecycle of a pull request before and once it enters a merge queue.

Using Piorities

Learn how to order your pull requests in the queue by priority.


Learn how to freeze your merge queues during incidents or planned events.

Using Multiple Queues

Learn how to implement multiple merge queues and route your pull requests.

Speculative Checks

Accelerates the merging process by testing the compatibility of multiple queued pull requests in parallel.


Increase your merge queue throughput and decrease your CI usage.


Optimize your merge queue for monorepos.


Smoothly transition to Mergify while optimizing the merge queue and potentially moving to Mergify exclusive merges.

Technical Reference

Detailed documentation about every part of Mergify.

Configuration File Format

Details of the configuration file format.

Sharing Configuration

Share and reuse configuration pieces in your configuration..


Everything you need to know when writing your conditions.

Configuration Data Types

Details of the data types found in the configuration


Complete list of commands you can use with Mergify.

API Usage

Integrate with Mergify using its API.



Integration with other systems.

Stacked PRs

How to create and manage stacked PRs.


Display your Mergify usage publicly.


Discussing Mergify's security.


How Mergify billing works.

Join our Community 💬

We love hearing from you! Here are a few ways you can connect with us and other Mergify community members.

Edit on GitHub


  • About Us
  • Careers
  • Customers
  • Media Kit