Mergify Documentation

Learn how to deploy Mergify on your repositories.

An overview of Mergify Workflow Automation and its capabilities to supercharge your pull request process.

Write your first automation rule using Mergify workflow automation.

A complete list of actions you can use with Mergify.

Merge your pull requests as soon as they are ready.

Schedule your pull requests at the right time.

Enhance your review workflow with customized, efficient, and dynamic review assignments tailored to your needs.

How to automatically delete head branches.

Optimize your pull request workflow, tailoring review dismissal to specific scenarios and users.

Bring your pull requests up-to-date with their base branch automatically.

Go beyond GitHub's native branch protections and craft custom, advanced rules using Mergify.

Learn how to deploy Mergify on your repositories.

Understand what merge queues are and how to use them.

Implement your first merge queue.

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

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

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

Understand the pause feature of Mergify's merge queue and how it can be utilized during CI incidents.

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

Optimizing your merge queue for maximum efficiency.

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.

Run essential tests on every PR and comprehensive tests before merging, optimizing CI time and resources.

Optimize your merge queue for monorepos.

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

Monitor key metrics of your merge queue to optimize throughput and reduce latency, ensuring a streamlined development cycle.

Solutions for troubleshooting common issues with Mergify's merge queue to ensure smooth and efficient pull request processing.

Details of the configuration file format.

Share and reuse configuration pieces in your configuration.

Everything you need to know when writing your conditions.

Details of the data types found in the configuration

Complete list of commands you can use with Mergify.

Integrate with Mergify using its API.

Complete Mergify API reference.

Integration with other systems.

How to create and manage stacked PRs.

Display your Mergify usage publicly.

Learn more about the applications permissions and Mergify's security obsession.

How Mergify billing works.