Status badges

A Project status badge is a dynamically generated image displaying the status of the last build. You can put a status badge on the home page of your GitHub project or intranet portal:

Grunt status

You can see a badge image URL and sample markup on the Badges tab of project settings. Badge URLs for both private and public projects contain a security token.

Display badge for specific branch

The default badge URL you see on the Badges tab returns the status of the last build of any branches.

To display the status of a specific branch append /branch/<branch-name> to that URL, for example:

To link specific branch with the project add /branch/<branch-name> to project URL, for example:

Retina support

To get a hi-res badge image for retina displays append retina=true parameter to the badge image URL, as follows:

Grunt status

SVG badges

To get badge image in SVG format append svg=true parameter to the image URL:


Grunt status

and of course SVG badge could be easily scaled:

<img src="" alt="Project Badge" width="300">

Project Badge

Customizing titles

You can customize SVG badge titles for pending, failing and passing states with pendingText, failingText and passingText query parameters respectively.

For example:

<img src="" alt="Project Badge">

Project Badge

Badges for projects with public repositories on GitHub and Bitbucket

You can infer badge URL for projects with public repositories, well, provided there is only a single project with this repository in AppVeyor.

The format of badge status image URL:{github|bitbucket}/{repository}

For example:

Optional parameters:

  • branch={name} - the name of branch to display status for;
  • retina=true - status image scaled up for retina display;
  • svg=true - status image in SVG format;


Note: The retina and svg parameters are mutually exclusive; only the first parameter specified is used.

Did you know that you can edit this page on GitHub and send us a Pull Request?