Как добавить значок статуса Bencher

Значок статуса Bencher показывает, есть ли у вашего проекта активные предупреждения:

• Bencher | passing, когда у проекта нет активных предупреждений
• Bencher | failing, когда у проекта есть хотя бы одно активное предупреждение

Предупреждение создается, когда новый результат пересекает порог. Предупреждение остается активным, пока его не отклонят или не заглушат. Предупреждения в архивированных ветке, тестовом стенде или мере не учитываются, так же как на вкладке Alerts вашего проекта в консоли Bencher.

Добавление значка в README

Добавьте этот Markdown в README, где <project> означает slug или UUID вашего проекта:

![Bencher](https://api.bencher.dev/v0/projects/<project>/badge)

Чтобы учитывать только предупреждения в одной ветке, добавьте параметр запроса branch с именем, slug или UUID ветки. Аналогично, параметр запроса testbed учитывает только предупреждения на одном тестовом стенде. Символ / в имени можно закодировать как %2F, например ?branch=release%2F1.0.

![Bencher](https://api.bencher.dev/v0/projects/<project>/badge?branch=main)

Чтобы значок вел к предупреждениям вашего проекта в консоли Bencher:

[![Bencher](https://api.bencher.dev/v0/projects/<project>/badge?branch=main)](https://bencher.dev/console/projects/<project>/alerts)

Bencher Self-Hosted

Для Bencher Self-Hosted используйте URL вашего собственного API-сервера:

![Bencher](https://<api-host>/v0/projects/<project>/badge)

Приватные проекты

Для значка приватного проекта нужен API-ключ, а изображение в README не может его отправить. Используйте значок в публичном README только для публичного проекта.

Обновления

Значок может кэшироваться до 5 минут, поэтому он обновляется в течение примерно 5 минут после того, как предупреждение создано или отклонено.