Concise, consistent, and legible badges in SVG and raster format
Clone or download
Permalink
Failed to load latest commit information.
.circleci Optionally persist [Github] tokens in Redis (#1939) Aug 19, 2018
.github Add multiple issue templates (#2128) Sep 30, 2018
__snapshots__ delete snapshots with no corresponding test (#2111) Sep 24, 2018
doc Add support for private [npm] packages (#2187) Oct 20, 2018
frontend Remove use of componentWillReceiveProps() (#2192) Oct 20, 2018
lib use most permissive license color (#2196) Oct 20, 2018
logo Add Gitlab logo (#1804) Aug 1, 2018
pages render category links correctly on initial page load (#2046) Sep 2, 2018
public Add monitoring platform Dec 3, 2017
services test "static" gitter service behaviour (#2199) Oct 20, 2018
spec fix inline image path (#1427) Jan 6, 2018
static List the named logos in the frontend (#1794) Jul 23, 2018
templates support for colorA + logo when no label specified (#1896) Aug 11, 2018
.buildpacks Node engine version information. Deployment files. Jan 3, 2014
.dockerignore Improve Docker run (envsubst, Alpine, documented env file) (#870) May 7, 2017
.editorconfig .editorconfig file to help all contributers to align to a common proj… Nov 5, 2015
.eslintignore Add snapshot tests for SVG and JSON (#1557) Mar 11, 2018
.eslintrc-frontend.yml Enforce no extensions in require (#1999) Sep 1, 2018
.eslintrc.yml Enforce no extensions in require (#1999) Sep 1, 2018
.gitignore List the named logos in the frontend (#1794) Jul 23, 2018
.nycrc.json Update coverage scripts (#2008) Aug 29, 2018
.prettierignore Prettify the files in the project root (#2041) Sep 2, 2018
.prettierrc.yml Turn on prettier (except repo root) (#1167) Aug 8, 2018
CONTRIBUTING.md Precommit hook with Prettier and ESLint (#2178) Oct 19, 2018
Dockerfile use FONT_PATH in Dockerfile (#2179) Oct 19, 2018
LICENSE License's content and filename changed (#2146) Oct 5, 2018
Makefile Optionally persist [Github] tokens in Redis (#1939) Aug 19, 2018
README.md License's content and filename changed (#2146) Oct 5, 2018
app.json Frontend: Allow BASE_URL to be unset (#1306) Dec 1, 2017
benchmark-performance.sh Speed up font-width computation in most cases (#1390) Dec 27, 2017
dangerfile.js Prettify the files in the project root (#2041) Sep 2, 2018
favicon.png favicon.png recompress with zopflipng losslessly Mar 12, 2016
next.config.js Prettify the files in the project root (#2041) Sep 2, 2018
now.json Required files added to now.json config (#1718) Jun 15, 2018
package-lock.json Precommit hook with Prettier and ESLint (#2178) Oct 19, 2018
package.json Precommit hook with Prettier and ESLint (#2178) Oct 19, 2018
secret.tpl.json Add support for private [npm] packages (#2187) Oct 20, 2018
server.js treat label as override in static badge (#2116) Oct 6, 2018
server.spec.js treat label as override in static badge (#2116) Oct 6, 2018
shields.example.env Redirect the root only when configured (#1270) Nov 17, 2017

README.md

build status commits to be deployed Total alerts chat on Discord follow on Twitter

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 470 million images.

In addition to hosting the shields.io frontend and server code, this monorepo hosts an NPM library for generating badges, and the badge design specification.

Examples

  • build status: build | failing
  • code coverage percentage: coverage | 80%
  • stable release version: version | 1.2.3
  • package manager release: gem | 1.2.3
  • status of third-party dependencies: dependencies | out-of-date
  • static code analysis GPA: code climate | 3.8
  • SemVer version observance: semver | 2.0.0
  • amount of Gratipay donations per week: tips | $2/week

Make your own badges! (Quick example: https://img.shields.io/badge/left-right-f39f37.svg)

Browse a complete list of badges.

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:

GitHub issues by-label

You can read a tutorial on how to add a badge.

Using the badge library

npm install -g gh-badges
badge build passed :green .png > mybadge.png
const badge = require('gh-badges')

// Optional step, to have accurate text width computation.
const format = {
  text: ['build', 'passed'],
  colorscheme: 'green',
  template: 'flat',
}

badge.loadFont('/path/to/Verdana.ttf', err => {
  badge(format, (svg, err) => {
    // svg is a string containing your badge
  })})

View the documentation for gh-badges.

Note: The badge library was last released in 2016.

npm version

Development

  1. Install Node 8 or later. You can use the package manager of your choice. Tests need to pass in Node 8 and 9.
  2. Clone this repository.
  3. Run npm install to install the dependencies.
  4. Run npm run build to build the frontend.
  5. Run npm start to start the server.
  6. Open http://[::]:8080/ to view the home page.

To generate the frontend using production cache settings – that is, badge preview URIs with maxAge – run LONG_CACHE=true npm run build.

To analyze the frontend bundle, run npm install webpack-bundle-analyzer and then ANALYZE=true npm start.

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:js:server to preview changes to the saved snapshots, and SNAPSHOT_UPDATE=1 npm run test:js:server to update them.

The server can be configured to use Sentry.

Hosting your own server

There is documentation about hosting your own server.

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

espadrine is the sysadmin.

These contributors donate time on a consistent basis to help guide and maintain the project:

Related projects

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.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]