🎖 Badge🔗
Mergify offers badges that you can use in your project to inform contributors that your repository is managed by Mergify.
The badge URL for a badge repository is:
https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/<owner>/<repo>
<owner> and <repo> are placeholders which have to be adapted to the
repository. For example:
https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/mergifyio/mergify-engine&style=flat
is a valid URL.
Embedding🔗
You can embed those badges by adding them to, e.g., your README files.
In a
README.md, add:
[![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>&style=flat
In a
README.rst, add:
.. image:: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/<owner>/<repo>&style=flat
:target: https://mergify.com
:alt: Mergify Status
Styles🔗
You can change the style of the badge by customizing the style= option at
the end of the URL. Here's the list of possible values:
Style |
Example |
|---|---|
|
|
|
|
|
|
|
|
|
|
