GitHub commit check runs
The Check Runs service shows the status of GitHub action runs.
You can help increase Shields.io's rate limit by authorizing the Shields.io GitHub application. Read more about how it works.
Path Parameters |
---|
user string — REQUIREDExample:
|
repo string — REQUIREDExample:
|
commit string — REQUIREDExample:
|
Query Parameters |
---|
nameFilter stringName of a check run Example:
|
style stringPossible values: [ If not specified, the default style for this badge is "flat". Example:
|
logo stringIcon slug from simple-icons. 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:
|
logoColor stringThe color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos. Example:
|
logoSize stringMake icons adaptively resize by setting Example:
|
label stringOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!) Example:
|
labelColor stringBackground color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
color stringBackground color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
cacheSeconds stringHTTP 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:
|
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 |