Skip to main content

GitHub branch status

Displays the status of a tag, commit, or branch, as reported by the Commit Status API. Nowadays, GitHub Actions and many third party integrations report state via the Checks API. If this badge does not show expected values, please try out our corresponding Check Runs badge instead. You can read more about status checks in the GitHub documentation.

Вы можете помочь увеличить лимит скорости Shields.io на авторизация приложения Shields.io GitHub. Узнайте больше о как это работает.

Path Parameters
user string REQUIRED

Example: badges

repo string REQUIRED

Example: shields

branch string REQUIRED

Example: master

Query Parameters
style string

Possible values: [flat, flat-square, plastic, for-the-badge, social]

Если не указано, стиль по умолчанию для этого значка будет "flat".

Example: flat

logo string

Иконка из simple-icons. Вы можете щелкнуть по названию иконки на simple-icons, чтобы скопировать slug, или они могут быть найдены в файле slugs.md в репозитории simple-icons. Дополнительная информация.

Example: appveyor

logoColor string

Цвет логотипа (hex, rgb, rgba, hsl, hsla и css-названия цветов поддерживаются). Поддерживается для логотипов simple-icons, но не для кастомных логотипов.

Example: violet

logoSize string

Настройте адаптивный размер иконок, установив значение auto. Это полезно для более широких логотипов, таких как amd и amg. Поддерживается для логотипов simple-icons, но не для кастомных логотипов.

Example: auto

label string

Переопределите текст на левой части значка (URL-encoded для пробелов или специальных символов!).

Example: healthiness

labelColor string

Цвет фона левой части (поддерживаются hex, rgb, rgba, hsl, hsla и css-названия цветов).

Example: abcdef

color string

Цвет фона правой части (поддерживаются hex, rgb, rgba, hsl, hsla и css-названия цветов).

Example: fedcba

cacheSeconds string

Время жизни HTTP-кэша (правила применяются для вычисления значения по умолчанию для каждого значка, любые указанные значения, ниже значения по умолчанию, будут игнорироваться).

Example: 3600

link string[]

Укажите, что должно происходить при клике на левую/правую часть значка. Обратите внимание, что это работает только при интеграции значка в тег HTML <object>, но не в тег <img> или разметку.