brigadecore/badgr repository overview

⁠Badgr

Badgr's creators love using shields.io⁠, for displaying various project statuses in our READMEs, but it doesn't support something we wanted badly-- the ability to generate a badge based on the results of a GitHub check suite associated with a specific GitHub App.

Badgr is a simple server that, given a repo owner, repo name, and optional branch name, can query for and consolidate GitHub check suite results and then delegate to shields.io⁠ to generate the corresponding badge. If a GitHub App ID is also specified, the badge will reflect only the results of check suites associates with that App.

Badgr also uses Redis to cache results to avoid getting rate limited by the GitHub Checks API. The cache is composed of warm and cold layers. The warm layer caches results short term to balance the need for up-to-date results against the desire to not be rate limited. The cold layer caches results longer term to return a relatively recent result in the event of a communication failure with GitHub.

Refer to our GitHub repository for more information.⁠