# Mergify

> Documentation for Mergify: automate merges, manage merge queues, enforce policies, provide CI observability and telemetry, and streamline GitHub workflows.

## Merge Queue

- [Merge Queue](https://docs.mergify.com/merge-queue.md): Ship faster with zero broken builds. Parallel testing, smart batching, and CI cost optimization.
  - [Merge Queue](https://docs.mergify.com/merge-queue.md): Ship faster with zero broken builds. Parallel testing, smart batching, and CI cost optimization.
  - [Setting Up a Merge Queue](https://docs.mergify.com/merge-queue/setup.md): Get your merge queue running in 5 minutes.
  - [Queue Modes](https://docs.mergify.com/merge-queue/queue-modes.md): Choose how the merge queue schedules pull requests — serial, parallel, or isolated.
  - [Using Queue Rules](https://docs.mergify.com/merge-queue/rules.md): Learn how to implement queue rules and route your pull requests.
  - [Merge Strategies](https://docs.mergify.com/merge-queue/merge-strategies.md): Choose how pull requests are merged into your base branch and control the shape of your git history.
  - [Pull Request Lifecycle](https://docs.mergify.com/merge-queue/lifecycle.md): Understand the lifecycle of a pull request before and once it enters a merge queue.
  - [Using Priorities](https://docs.mergify.com/merge-queue/priority.md): Learn how to order your pull requests in the queue by priority.
  - [Pausing the Merge Queue](https://docs.mergify.com/merge-queue/pause.md): Understand the pause feature and how it can be utilized during CI incidents.
  - [Performance](https://docs.mergify.com/merge-queue/performance.md): Optimizing your merge queue for maximum efficiency.
  - [Merge Queue Batches](https://docs.mergify.com/merge-queue/batches.md): Increase your merge queue throughput and decrease your CI usage.
  - [Merge Queue Scopes](https://docs.mergify.com/merge-queue/scopes.md): Understand how Mergify groups pull requests by scope to build the most effective batches.
    - [Merge Queue Scopes](https://docs.mergify.com/merge-queue/scopes.md): Understand how Mergify groups pull requests by scope to build the most effective batches.
    - [Scopes with File Patterns](https://docs.mergify.com/merge-queue/scopes/file-patterns.md): Configure merge queue scopes using file patterns to batch pull requests intelligently.
    - [Scopes with Nx](https://docs.mergify.com/merge-queue/scopes/nx.md): Configure merge queue scopes using Nx's dependency graph to drive batching.
    - [Scopes with Bazel](https://docs.mergify.com/merge-queue/scopes/bazel.md): Configure merge queue scopes using Bazel's dependency graph for precise batching.
    - [Scopes with Turborepo](https://docs.mergify.com/merge-queue/scopes/turborepo.md): Configure merge queue scopes using Turborepo's dependency graph awareness.
    - [Scopes with Other Build Tools](https://docs.mergify.com/merge-queue/scopes/others.md): Configure merge queue scopes using your preferred monorepo tooling.
  - [Stacked Pull Requests](https://docs.mergify.com/merge-queue/stacks.md): How the merge queue handles stacks created by mergify stack push — auto-propagation, stack-aware batching, and cascade dequeue.
  - [Monorepo](https://docs.mergify.com/merge-queue/monorepo.md): Optimize merge queue batching for monorepos with scopes.
  - [Implementing a Two-Step CI with Mergify](https://docs.mergify.com/merge-queue/two-step.md): Run essential tests on every PR and comprehensive tests before merging, optimizing CI time and resources.
  - [Deploying your Merge Queue](https://docs.mergify.com/merge-queue/deploy.md): Deploy Mergify's merge queue with a hybrid approach or enforce exclusive automated merges.
  - [GitHub Rulesets Compatibility](https://docs.mergify.com/merge-queue/github-rulesets.md): How Mergify interacts with GitHub branch protections and rulesets, including known incompatibilities and how to resolve them.
  - [Monitoring your Merge Queue](https://docs.mergify.com/merge-queue/monitoring.md): Monitor key metrics of your merge queue to optimize throughput and reduce latency, ensuring a streamlined development cycle.

## CI Insights

- [CI Insights](https://docs.mergify.com/ci-insights.md): Optimize your CI run time, catch flaky tests, and give developers actionable insights so your team ships code faster.
  - [CI Insights](https://docs.mergify.com/ci-insights.md): Optimize your CI run time, catch flaky tests, and give developers actionable insights so your team ships code faster.
  - [Jobs](https://docs.mergify.com/ci-insights/jobs.md): Track your CI job health, duration, and cost to identify flaky, broken, or expensive jobs before they slow down your team.
  - [Auto-Retry](https://docs.mergify.com/ci-insights/auto-retry.md): Automatically retry failed CI jobs to reduce false negatives caused by flaky tests and transient failures.
  - [Flaky Test Detection](https://docs.mergify.com/ci-insights/flaky-test-detection.md): Set up automated flaky test detection to identify unreliable tests in your CI pipeline and improve test suite reliability.
  - [Self-hosted runners](https://docs.mergify.com/ci-insights/runners.md): Monitor the self-hosted CI runners behind your pipelines so you can spot capacity bottlenecks, degraded machines, and wasted spend.
  - [CI Insights Setup – GitHub Actions](https://docs.mergify.com/ci-insights/setup/github-actions.md): Enable Mergify CI Insights and configure flaky test detection using GitHub Actions.
  - [CI Insights Setup – Buildkite](https://docs.mergify.com/ci-insights/setup/buildkite.md): Enable Mergify CI Insights and configure flaky test detection using Buildkite.
  - [CI Insights Setup – Jenkins](https://docs.mergify.com/ci-insights/setup/jenkins.md): Enable Mergify CI Insights and configure flaky test detection using Jenkins.

## Test Insights

- [Test Insights](https://docs.mergify.com/test-insights.md): Monitor, detect, and manage unreliable tests across your repositories.
  - [Test Insights](https://docs.mergify.com/test-insights.md): Monitor, detect, and manage unreliable tests across your repositories.
  - [Prevention](https://docs.mergify.com/test-insights/prevention.md): Catch flaky and broken tests on pull requests before they reach your codebase.
  - [Detection](https://docs.mergify.com/test-insights/detection.md): Identify and prioritize unhealthy tests across your repositories.
  - [Mitigation](https://docs.mergify.com/test-insights/mitigation.md): Quarantine problematic tests to unblock CI without losing visibility.
  - [Quarantine](https://docs.mergify.com/test-insights/quarantine.md): Ignore problematic tests in your CI
  - [Test Insights](https://docs.mergify.com/test-insights.md): Monitor, detect, and manage unreliable tests across your repositories.
    - [Cypress Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/cypress.md): Report your test results from Cypress to Mergify
    - [Go Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/golang.md): Report your test results from Go tests to Mergify
    - [Jest Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/jest.md): Report your test results from Jest tests to Mergify
    - [JUnit Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/junit.md): Report your test results from JUnit tests to Mergify
    - [Minitest Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/minitest.md): Report your test results from Minitest tests to Mergify
    - [MSTest Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/mstest.md): Report your test results from MSTest tests to Mergify
    - [NUnit Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/nunit.md): Report your test results from NUnit tests to Mergify
    - [Pest Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/pest.md): Report your test results from Pest tests to Mergify
    - [PHPUnit Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/phpunit.md): Report your test results from PHPUnit tests to Mergify
    - [Playwright Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/playwright.md): Report your test results from Playwright to Mergify
    - [Pytest Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/pytest.md): Report your test results from pytest to Mergify
    - [RSpec Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/rspec.md): Report your test results from RSpec to Mergify
    - [Rust Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/rust.md): Report your test results from Rust tests to Mergify
    - [TestNG Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/testng.md): Report your test results from TestNG tests to Mergify
    - [Vitest Integration with Mergify](https://docs.mergify.com/test-insights/test-frameworks/vitest.md): Report your test results from Vitest to Mergify

## Merge Protections

- [Merge Protections](https://docs.mergify.com/merge-protections.md): Go beyond GitHub's native branch protections and craft custom, advanced rules using Mergify.
  - [Merge Protections](https://docs.mergify.com/merge-protections.md): Go beyond GitHub's native branch protections and craft custom, advanced rules using Mergify.
  - [Enabling & Configuring Merge Protections](https://docs.mergify.com/merge-protections/setup.md): How to enable Merge Protections and make the required check effective.
  - [Auto-Merge](https://docs.mergify.com/merge-protections/auto-merge.md): Automatically merge or queue pull requests when all merge protection conditions pass.
  - [Built‑in Merge Protections](https://docs.mergify.com/merge-protections/builtin.md): Protections available out of the box: Depends-On, Merge-After, Configuration Changed.
  - [Writing Custom Merge Protection Rules](https://docs.mergify.com/merge-protections/custom-rules.md): Define fine-grained success conditions evaluated by the Mergify Merge Protections check.
  - [Scheduling Freezes](https://docs.mergify.com/merge-protections/freeze.md): Temporarily block merging during maintenance, release, or blackout windows.
  - [Merge Protection Examples & Patterns](https://docs.mergify.com/merge-protections/examples.md): Practical rule recipes for common compliance, quality, and coordination needs.

## Stacks

- [Stacks](https://docs.mergify.com/stacks.md): Break large changes into small, reviewable pull requests. One branch, many PRs.
  - [Stacks](https://docs.mergify.com/stacks.md): Break large changes into small, reviewable pull requests. One branch, many PRs.
  - [Concepts](https://docs.mergify.com/stacks/concepts.md): How Mergify Stacks maps Git commits to GitHub pull requests.
  - [Setup](https://docs.mergify.com/stacks/setup.md): Install Mergify CLI and configure your repository for stacked PRs.
  - [Creating Stacks](https://docs.mergify.com/stacks/creating.md): Walk through creating your first stack of pull requests.
  - [Updating Stacks](https://docs.mergify.com/stacks/updating.md): Amend, reorder, add, or remove commits in your stack.
  - [Reviewing Stacks](https://docs.mergify.com/stacks/reviewing.md): A reviewer's guide to navigating and reviewing stacked pull requests.
  - [Team Adoption](https://docs.mergify.com/stacks/team.md): Why and how to roll out stacked PRs across your engineering team.
  - [Compare Stacking Tools](https://docs.mergify.com/stacks/compare.md): Honest comparisons between Mergify Stacks and other stacked PR tools.
    - [Compare Stacking Tools](https://docs.mergify.com/stacks/compare.md): Honest comparisons between Mergify Stacks and other stacked PR tools.
    - [Mergify Stacks vs Plain Git](https://docs.mergify.com/stacks/compare/plain-git.md): An honest comparison of Mergify Stacks and stacking by hand with git rebase and gh pr create.
    - [Mergify Stacks vs gh-stack](https://docs.mergify.com/stacks/compare/gh-stack.md): An honest comparison of Mergify Stacks and GitHub's gh-stack CLI for stacked pull requests.
    - [Mergify Stacks vs Graphite](https://docs.mergify.com/stacks/compare/graphite.md): An honest comparison of Mergify Stacks and Graphite's stacking workflow.

## Workflow Automation

- [Workflow Automation](https://docs.mergify.com/workflow.md): Automate the routine work on your pull requests with rules that react to a pull request's state to label, comment, assign, rebase, merge, and more.
  - [Workflow Automation](https://docs.mergify.com/workflow.md): Automate the routine work on your pull requests with rules that react to a pull request's state to label, comment, assign, rebase, merge, and more.
  - [Rule Syntax](https://docs.mergify.com/workflow/rule-syntax.md): How to write a Mergify workflow rule, from the structure of pull_request_rules to its conditions and actions.
  - [Actions](https://docs.mergify.com/workflow/actions.md): A complete list of actions you can use with Mergify.
    - [Assign](https://docs.mergify.com/workflow/actions/assign.md): Assign a pull request to a user.
    - [Backport](https://docs.mergify.com/workflow/actions/backport.md): Copy a pull request to another branch once it is merged.
    - [Close](https://docs.mergify.com/workflow/actions/close.md): Close a pull request.
    - [Copy](https://docs.mergify.com/workflow/actions/copy.md): Copy a pull request to another branch.
    - [Comment](https://docs.mergify.com/workflow/actions/comment.md): Post a comment on a pull request.
    - [Delete Head Branch (Deprecated)](https://docs.mergify.com/workflow/actions/delete_head_branch.md): Delete pull request head branch. Deprecated in favor of GitHub's built-in "Automatically delete head branches" setting.
    - [Dismiss Reviews](https://docs.mergify.com/workflow/actions/dismiss_reviews.md): Dismiss previous reviews on a pull request.
    - [Edit](https://docs.mergify.com/workflow/actions/edit.md): Convert a pull request to or from a draft.
    - [GitHub Actions](https://docs.mergify.com/workflow/actions/github_actions.md): Dispatch an existing GitHub workflow in the repository.
    - [Label](https://docs.mergify.com/workflow/actions/label.md): Add, remove, or toggle labels on a pull request.
    - [Merge](https://docs.mergify.com/workflow/actions/merge.md): Automate the merging of your pull requests.
    - [Post Check (Deprecated)](https://docs.mergify.com/workflow/actions/post_check.md): Create a check-run on a pull request. Deprecated in favor of Merge Protections.
    - [Queue](https://docs.mergify.com/workflow/actions/queue.md): Add the pull request to the merge queue.
    - [Rebase](https://docs.mergify.com/workflow/actions/rebase.md): Rebase the pull request on top of its base branch.
    - [Request Reviews](https://docs.mergify.com/workflow/actions/request_reviews.md): Request reviews from specific users or teams.
    - [Review](https://docs.mergify.com/workflow/actions/review.md): Automate reviews for your pull requests with customizable comments and review types.
    - [Update](https://docs.mergify.com/workflow/actions/update.md): Update the pull request branch with its base branch.
    - [Squash](https://docs.mergify.com/workflow/actions/squash.md): Squash commits in the pull request.

## Monorepo CI

- [Monorepo CI](https://docs.mergify.com/monorepo-ci.md): Run the right tests for the right pull requests by combining scopes with your CI system.
  - [Monorepo CI](https://docs.mergify.com/monorepo-ci.md): Run the right tests for the right pull requests by combining scopes with your CI system.
  - [Monorepo CI with GitHub Actions](https://docs.mergify.com/monorepo-ci/github-actions.md): Use `gha-mergify-ci` to run only the workflows impacted by a pull request.
  - [Monorepo CI with Buildkite](https://docs.mergify.com/monorepo-ci/buildkite.md): Use the Mergify CI Buildkite plugin to run only the pipelines impacted by a pull request.

## Rule Engine

- [Mergify Configuration File](https://docs.mergify.com/configuration/file-format.md): Everything you need to know about Mergify configuration file
- [Mergify Conditions](https://docs.mergify.com/configuration/conditions.md): Everything you need to know when writing conditions in Mergify
- [Configuration Data Types](https://docs.mergify.com/configuration/data-types.md): The different data types you can find in Mergify configuration file
- [Sharing Configuration](https://docs.mergify.com/configuration/sharing.md): Learn how to share and reuse configuration pieces in your configuration.

## Commands

- [Mergify Commands](https://docs.mergify.com/commands.md): Complete list of commands you can use with Mergify.
- [Command Restriction](https://docs.mergify.com/commands/restrictions.md): Set limitations on who can execute specific Mergify commands.
- [Mergify Backport Command](https://docs.mergify.com/commands/backport.md): Copy a pull request to another branch after merge.
- [Mergify Copy Command](https://docs.mergify.com/commands/copy.md): Copy a pull request to another branch.
- [Mergify Queue Command](https://docs.mergify.com/commands/queue.md): Add a pull request to a merge queue.
- [Mergify Rebase Command](https://docs.mergify.com/commands/rebase.md): Rebase a pull request.
- [Mergify Refresh Command](https://docs.mergify.com/commands/refresh.md): Refresh Mergify status of a pull request.
- [Mergify Squash Command](https://docs.mergify.com/commands/squash.md): Squash the commits of a pull request into one.
- [Mergify Update Command](https://docs.mergify.com/commands/update.md): Update a pull request by merging its base branch into it.
- [Mergify Dequeue Command](https://docs.mergify.com/commands/dequeue.md): Remove a pull request from a merge queue.

## API

- [API Usage](https://docs.mergify.com/api/usage.md): Learn how to authenticate and work with the Mergify REST API.

## CLI

- [CLI Installation & Authentication](https://docs.mergify.com/cli/usage.md): Install the Mergify CLI and authenticate it to manage your merge queue, freezes, and stacked pull requests from the terminal.

## Integrations

- [Mergify Integration](https://docs.mergify.com/integrations.md): Mergify integration with other systems.
  - [Integrating GitHub with Mergify](https://docs.mergify.com/integrations/github.md): Managing Mergify GitHub installation.
  - [Integrating GitHub Actions with Mergify](https://docs.mergify.com/integrations/gha.md): Run CI Insights, Monorepo CI, and Merge Queue Scopes on GitHub Actions, and trigger workflows from Mergify rules.
  - [Integrating Buildkite with Mergify](https://docs.mergify.com/integrations/buildkite.md): Run CI Insights, Monorepo CI, and Merge Queue Scopes on Buildkite.
  - [Integrating Jenkins with Mergify](https://docs.mergify.com/integrations/jenkins.md): Run CI Insights via the Mergify Jenkins plugin and Merge Queue Scopes through the Mergify CLI.
  - [Integrating Any CI with Mergify](https://docs.mergify.com/integrations/ci-status-checks.md): Run CI Insights and Merge Queue Scopes on CircleCI, GitLab CI, TeamCity, or any CI that reports status checks to GitHub.
  - [Using Datadog with Mergify](https://docs.mergify.com/integrations/datadog.md): Learn how you can monitor Mergify using Datadog.
  - [Using Slack with Mergify](https://docs.mergify.com/integrations/slack.md): Learn how you can send Slack notifications for Merge Queue events, CI Insights, Test Insights quarantine activity, and pull request activities.
  - [Integrating Dependabot with Mergify](https://docs.mergify.com/integrations/dependabot.md): How to automate your dependencies update using Mergify.
  - [Managing Mergify with Terraform](https://docs.mergify.com/integrations/terraform.md): How to manage Mergify configuration declaratively with the official Terraform provider.

## Migrate to Mergify

- [Migrate to Mergify](https://docs.mergify.com/migrate.md): Guides to migrate from popular tools and bots to Mergify.
  - [Migrate to Mergify](https://docs.mergify.com/migrate.md): Guides to migrate from popular tools and bots to Mergify.
  - [Migrate from Bulldozer to Mergify](https://docs.mergify.com/migrate/bulldozer.md): Move from Bulldozer automerge to Mergify's Merge Queue for safer, faster merges.
  - [Migrate from Bors‑NG to Mergify](https://docs.mergify.com/migrate/bors-ng.md): Map Bors‑NG try/staging queues and permissions to Mergify rules and Merge Queue.
  - [Migrate from GitHub Merge Queue to Mergify](https://docs.mergify.com/migrate/github-merge-queue.md): Technical mapping of GitHub Merge Queue concepts to Mergify with added capabilities.

## Browser Extensions

- [Browser Extensions](https://docs.mergify.com/browser-extensions.md): Install the Chrome or Firefox extension to surface Mergify Merge Queue and stack controls, plus read report timestamps in your own timezone, directly inside GitHub pull requests.

## Security

- [Security](https://docs.mergify.com/security.md): Mergify's security posture — compliance, data handling, access control, and the GitHub App permissions we request.

## Support

- [Support](https://docs.mergify.com/support.md): Learn how to reach the Mergify support team, understand coverage, and explore enhanced support options.

## Billing

- [Mergify Billing System](https://docs.mergify.com/billing.md): Understand how Mergify fair billing works.