This is home to Shields.io, a service for concise, consistent, and legible badges in SVG and raster format, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. Every month it serves over 870 million images and is used by some of the world's most popular open-source projects, VS Code, Vue.js and Bootstrap to name a few.
This repo hosts:
- The Shields.io frontend and server code
- An NPM library for generating badges
- The badge design specification
Examples
- code coverage percentage:
- stable release version:
- package manager release:
- status of third-party dependencies:
- static code analysis grade:
-
SemVer version observance:
- amount of Liberapay donations per week:
- Python package downloads:
- Chrome Web Store extension rating:
-
Uptime Robot percentage:
Make your own badges!
(Quick example: https://img.shields.io/badge/left-right-f39f37)
Quickstart
Browse a complete list of badges and locate a particular badge by using the search bar or by browsing the categories. Click on the badge to fill in required data elements for that badge type (like your username or repo) and optionally customize (label, colors etc.). And it's ready for use!
Use the button at the bottom to copy your badge url or snippet, which can then be added to places like your GitHub readme files or other web pages.
Contributing
Shields is a community project. We invite your participation through issues and pull requests! You can peruse the contributing guidelines.
When adding or changing a service please add tests.
This project has quite a backlog of suggestions! If you're new to the project, maybe you'd like to open a pull request to address one of them.
You can read a tutorial on how to add a badge.
Development
- Install Node 16 or later. You can use the package manager of your choice. Tests need to pass in Node 16 and 17.
- Clone this repository.
- Run
npm cito install the dependencies. - Run
npm startto start the badge server and the frontend dev server. - Open
http://localhost:3000/to view the frontend.
When server source files change, the badge server should automatically restart
itself (using nodemon). When the frontend files change, the frontend dev
server (gatsby dev) should also automatically reload. However the badge
definitions are built only before the server first starts. To regenerate those,
either run npm run defs or manually restart the server.
To debug a badge from the command line, run npm run badge -- /npm/v/nock.
It also works with full URLs like
npm run badge -- https://img.shields.io/npm/v/nock.
Use npm run debug:server to start server in debug mode.
This recipe shows how to debug Node.js application in VS Code.
Shields has experimental support for Gitpod, a pre-configured development environment that runs in your browser. To use Gitpod, click the button below and sign in with GitHub. Gitpod also offers a browser add-on, though it is not required. Please report any Gitpod bugs, questions, or suggestions in issue #2772.
Snapshot tests ensure we don't inadvertently make changes that affect the
SVG or JSON output. When deliberately changing the output, run
SNAPSHOT_DRY=1 npm run test:package to preview changes to the saved
snapshots, and SNAPSHOT_UPDATE=1 npm run test:package to update them.
The server can be configured to use Sentry (configuration) and Prometheus (configuration).
Daily tests, including a full run of the service tests and overall code coverage, are run via badges/daily-tests.
Hosting your own server
There is documentation about hosting your own server.
Related projects
Status badges are used widely across open-source and private software projects. Academics have studied the "signal" badges provide about software project quality. There are many existing libraries for rendering these badges, and alternatives to the hosted Shields badge service. awesome-badges is a curated collection of such resources. Contributions may be considered there. (The presence of a project in that collection should not be interpreted as an endorsement nor promotion from the Shields project)
History
b.adge.me was the original website for this service. Heroku back then had a thing which made it hard to use a toplevel domain with it, hence the odd domain. It used code developed in 2013 from a library called gh-badges, both developed by Thaddée Tyl. The project merged with shields.io by making it use the b.adge.me code and closed b.adge.me.
The original badge specification was developed in 2013 by Olivier Lacan. It was inspired by the Travis CI and similar badges (there were a lot fewer, back then). In 2014 Thaddée Tyl redesigned it with help from a Travis CI employee and convinced everyone to switch to it. The old design is what today is called the plastic style; the new one is the flat style.
You can read more about the project's inception, the motivation of the SVG badge specification, and the specification itself.
Project leaders
Maintainers:
- calebcartwright (core team)
- chris48s (core team)
- Daniel15 (core team)
- paulmelnikow (core team)
- platan (core team)
- PyvesB (core team)
- RedSparr0w (core team)
Operations:
Alumni:
License
All assets and code are under the CC0 LICENSE and in the public domain unless specified otherwise.
The assets in logo/ are trademarks of their respective companies and are
under their terms and license.
Community
Thanks to the people and companies who donate money, services or time to keep the project running. https://shields.io/community