Badge

Display your Mergify usage publicly.


Mergify badges allow you to showcase that your repository is managed by Mergify. They’re a great way to let contributors know that your project uses automated workflows. Here’s how to add them to your project.

Every Mergify-managed repository has a unique badge URL. You can use this URL to embed a badge in your project’s README file, website, or any other location where you can insert an image URL.

The badge URL for a Mergify repository follows this format:

https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/<owner>/<repo>

Replace <owner> and <repo> with the username and repository name for your project. For example, the badge URL for the mergify-engine repository owned by mergifyio would be:

https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/Mergifyio/docs

Once you have the badge URL, you can embed the badge in your README file.

In a Markdown README (README.md)

Section titled In a Markdown README (README.md)

Add the following lines to your README:

[![Mergify Status][mergify-status]][mergify]
[mergify]: https://mergify.com
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/<owner>/<repo>

Remember to replace <owner> and <repo> with your project’s details.

In a reStructuredText README (README.rst)

Section titled In a reStructuredText README (README.rst)

Add the following lines to your README:

.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/<owner>/<repo>
:target: https://mergify.com
:alt: Mergify Status

Again, replace <owner> and <repo> with your project’s details.

You can customize the appearance of your Mergify badge by adding a style:

  • flat:
  • flat-square:
  • plastic:
  • for-the-badge:
  • social:

To apply a style, add &style=<style> to the end of the badge URL. For example, to use the flat-square style:

https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/<owner>/<repo>&style=flat-square