Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking

Test Results

AppVeyor tests:AppVeyor tests badge/appveyor/tests/:user/:repo
AppVeyor tests (branch):AppVeyor tests (branch) badge/appveyor/tests/:user/:repo/:branch
AppVeyor tests (compact):AppVeyor tests (compact) badge/appveyor/tests/:user/:repo?compact_message
AppVeyor tests with custom labels:AppVeyor tests with custom labels badge/appveyor/tests/:user/:repo?failed_label=bad&passed_label=good&skipped_label=n%2Fa
Azure DevOps tests:Azure DevOps tests badge/azure-devops/tests/:organization/:project/:definitionId/:branch*?compact_message&failed_label=failed&passed_label=passed&skipped_label=skipped
Azure DevOps tests (compact):Azure DevOps tests (compact) badge/azure-devops/tests/:organization/:project/:definitionId/:branch*?compact_message&failed_label=failed&passed_label=passed&skipped_label=skipped
Azure DevOps tests with custom labels:Azure DevOps tests with custom labels badge/azure-devops/tests/:organization/:project/:definitionId/:branch*?compact_message&failed_label=failed&passed_label=passed&skipped_label=skipped
Jenkins tests:Jenkins tests badge/jenkins/tests?compact_message&failed_label=failed&jobUrl=https%3A%2F%2Fjenkins.sqlalchemy.org%2Fjob%2Falembic_gerrit&passed_label=passed&skipped_label=skipped
Sonar Tests:Sonar Tests badge/sonar/tests/:component/:branch*?compact_message&failed_label=failed&passed_label=passed&server=http%3A%2F%2Fsonar.petalslink.com&skipped_label=skipped&sonarVersion=4.2
TAS Tests:TAS Tests badge/tas/tests/:provider/:org/:repo?compact_message&failed_label=failed&passed_label=passed&skipped_label=skipped
Testspace tests:Testspace tests badge/testspace/:metric/:org/:project/:space+
Testspace pass ratio:Testspace pass ratio badge/testspace/pass-ratio/:org/:project/:space+
Testspace tests:Testspace tests badge/testspace/tests/:org/:project/:space+?failed_label=failed&passed_label=passed&skipped_label=skipped
Testspace tests (compact):Testspace tests (compact) badge/testspace/tests/:org/:project/:space+?compact_message
Testspace tests with custom labels:Testspace tests with custom labels badge/testspace/tests/:org/:project/:space+?failed_label=bad&passed_label=good&skipped_label=n%2Fa

Your Badge

Static


Using dash "-" separator

/badge/<LABEL>-<MESSAGE>-<COLOR>

Dashes --- Dash
Underscores ___ Underscore
_ or Space    Space

Using query string parameters

/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

/badge/dynamic/json?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

/badge/dynamic/yaml?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>


Styles

The following styles are available. Flat is the default. Examples are shown with an optional logo:

?style=plastic&logo=appveyorplastic
?style=flat&logo=appveyorflat
?style=flat-square&logo=appveyorflat-square
?style=for-the-badge&logo=appveyorfor-the-badge
?style=social&logo=appveyorsocial

Here are a few other parameters you can use: (connecting several with "&" is possible)

?label=healthinessesOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!)
?logo=appveyorInsert one of the named logos from (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository.
?logo=data:image/png;base64,…Insert custom logo image (≥ 14px high). There is a limit on the total size of request headers we can accept (8192 bytes). From a practical perspective, this means the base64-encoded image text is limited to somewhere slightly under 8192 bytes depending on the rest of the request header.
?logoColor=violetSet the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.
?logoWidth=40Set the horizontal space to give to the logo
?link=http://left&link=http://rightSpecify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an<object> HTML tag, but not an<img> tag or a markup language.
?labelColor=abcdefSet background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported.
?color=fedcbaSet background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported.
?cacheSeconds=3600Set the HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). The legacy name "maxAge" is also supported.

We support .svg and .json. The default is .svg, which can be omitted from the URL.

While we highly recommend using SVG, we also support .png for use cases where SVG will not work. These requests should be made to our raster server https://raster.shields.io. For example, the raster equivalent of https://img.shields.io/npm/v/express is https://raster.shields.io/npm/v/express. For backward compatibility, the badge server will redirect .png badges to the raster server.

Like This?

Have an idea for an awesome new badge?
Tell us about it and we might bring it to you!

CommunityStatusMetricsGitHub