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.
Introducing Workflow Automation
An overview of Mergify Workflow Automation and its capabilities to supercharge your pull request process.
Writing Your First Rule
Write your first automation rule using Mergify workflow automation.
Actions
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.
Scheduling Merges
Schedule your pull requests at the right time.
Request Reviews
Enhance your review workflow with customized, efficient, and dynamic review assignments tailored to your needs.
Delete Head Branches
How to automatically delete head branches.
Dismiss Reviews
Optimize your pull request workflow, tailoring review dismissal to specific scenarios and users.
Rebasing Pull Requests
Bring your pull requests up-to-date with their base branch automatically.
Custom Branch Protections
Go beyond GitHub's native branch protections and craft custom, advanced rules using Mergify.
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.
Freeze
Learn how to freeze your merge queues during incidents or planned events.
Pause
Understand the pause feature of Mergify's merge queue and how it can be utilized during CI incidents.
Using Multiple Queues
Learn how to implement multiple merge queues and route your pull requests.
Performance
Optimizing your merge queue for maximum efficiency.
Speculative Checks
Accelerates the merging process by testing the compatibility of multiple queued pull requests in parallel.
Batches
Increase your merge queue throughput and decrease your CI usage.
Two-Step CI
Run essential tests on every PR and comprehensive tests before merging, optimizing CI time and resources.
Partitions
Optimize your merge queue for monorepos.
Deployment
Smoothly transition to Mergify while optimizing the merge queue and potentially moving to Mergify exclusive merges.
Monitoring
Monitor key metrics of your merge queue to optimize throughput and reduce latency, ensuring a streamlined development cycle.
Troubleshooting
Solutions for troubleshooting common issues with Mergify's merge queue to ensure smooth and efficient pull request processing.
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.
Conditions
Everything you need to know when writing your conditions.
Configuration Data Types
Details of the data types found in the configuration
Commands
Complete list of commands you can use with Mergify.
API Usage
Integrate with Mergify using its API.
API Reference
Complete Mergify API reference.
Other
Integrations
Integration with other systems.
Stacked PRs
How to create and manage stacked PRs.
Badge
Display your Mergify usage publicly.
Security
Learn more about the applications permissions and Mergify's security obsession.
Billing
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.