Skip to main content

Sonar Tests (branch)

The Sonar badges will work with both SonarCloud.io and self-hosted SonarQube instances. Just enter the correct protocol and path for your target Sonar deployment.

If you are targeting a legacy SonarQube instance that is version 5.3 or earlier, then be sure to include the version query parameter with the value of your SonarQube version.

You may change the "passed", "failed" and "skipped" text on this badge by supplying query parameters &passed_label=, &failed_label= and &skipped_label= respectively.

For example, if you want to use a different terminology:
?passed_label=good&failed_label=bad&skipped_label=n%2Fa

Or symbols:
?compact_message&passed_label=💃&failed_label=🤦‍♀️&skipped_label=🤷

There is also a &compact_message query parameter, which will default to displaying ✔, ✘ and ➟, separated by a horizontal bar |.

Path Parameters
component string — REQUIRED
Example: swellaby:letra
branch string — REQUIRED
Example: master
Query Parameters
server string — REQUIRED
Example: https://sonarcloud.io
sonarVersion string
Example: 4.2
compact_message boolean
passed_label string
Example: good
failed_label string
Example: bad
skipped_label string
Example: n/a
style string

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

If not specified, the default style for this badge is "flat".

Example: flat
logo string

One of the named logos (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. Further info.

Example: appveyor
logoColor string

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.

Example: violet
label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness
labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: abcdef
color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: fedcba
cacheSeconds string

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).

Example: 3600
link string[]

Specify 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.