Stark & Wayne

How to embed live Github PR status in your blogs & docs

[update: API is now at https://github-shields.com]

The following badges reflect the status of some pull requests and issues:

And issues:

This might be handy for you in blog posts ("I raised a bug for that [badge]"), documentation and READMEs.

There isn't yet a nice website to help you construct the URLs. Sorry. But the URL structures are very similar to GitHub's own URLs.

Consider the PR https://github.com/cloudfoundry/bosh/pull/715. The URL doesn't indicate if the PR is open/merged/closed.

The cloudfoundry/bosh/pull/715 portion of the URL is copied directly into the following base URL:

https://github-shields.com/github/ + cloudfoundry/bosh/pull/715 + .svg gives a URL that redirects to the PR.

https://github-shields.com/github/cloudfoundry/bosh/pull/715.svg

As an image URL it gives cloudfoundry/bosh/pull/715

Awesome, it was merged!

As a convenience, https://github-shields.com/github/ + cloudfoundry/bosh/pull/715 gives a URL that redirects to the PR itself on GitHub.

https://github-shields.com/github/cloudfoundry/bosh/pull/715

Compose the two together and you get clickable shields/badges.

In markdown this might be:

[![cloudfoundry/bosh/pull/715](https://github-shields.com/github/cloudfoundry/bosh/pull/715.svg)](https://github-shields.com/github/cloudfoundry/bosh/pull/715)

Giving us cloudfoundry/bosh/pull/715

Hopefully this makes our blog posts, comments and READMEs more exciting!

Run it yourself for private repos

See https://github.com/drnic/github-shields for instructions for deploying it yourself so you can access your private repo's issues/PR statuses.