View my tickets
Submit a ticket Try Snyk for free

Articles in this section

See more
  1. Support Portal | Snyk
  2. Snyk Platform
  3. Snyk basics

Badge Support for Repositories

  • Updated

For badging repositiories, we currently support for Node.js, Ruby or Java GitHub repositories.

Private repos are not supported for badges.

 


To show a badge for a given Node.js, Ruby or Java GitHub repository, copy the relevant snippet below and replace “{username}/{repo}” with the GitHub username and repo you want to test

HTML:

<*a href="https://snyk.io/test/github/{username}/{repo}">uuid-2678b218-659f-61c6-8e14-57964dfb2bc6-en.png

Markdown:

[![Known Vulnerabilities](https://snyk.io/test/github/{username}/{repo}/badge.svg)]

(https://snyk.io/test/github/{username}/{repo})

The badge will reflect the vulnerability state of the latest commit on the default branch. To show the vulnerability state of a specific branch, release or tag, simply add its name after the repo name in the URL.

For example, to show a badge for the 4.x branch of the express repo, use the URL https://snyk.io/test/github/expressjs/express/4.x/badge.svg.

More information on how to configure badges can be found in this document