Using a project badge

You can promote your SonarQube project’s status in third-party tools and external websites using project badges.

You can include dynamic SonarQube badges on your web pages to display information about your project such as the current value of specific metrics or the current quality gate status.

Markdown snippets and simple image URLs are provided to generate the badge code. A unique security token is generated for each project badge and is required to make the badge accessible from third-party tools.

Using project badges can expose sensitive information like your security rating and other metrics. You should only use them in trusted environments.

Generating the badge code

To generate the code of your dynamic project badge:

1. Retrieving projects.

2. In the top right corner, select Project Information.

3. In the Badges section:

   1. Select the information type you want to display: metric value or quality gate status.

   2. If you selected the metric value information type, select the metric in Customize badge.

   3. In Code format, select Markdown (markdown snippet) or Image URL only depending on how you want to include your badge.

   4. Select the Copy button to copy the code of your badge.

Renewing the badge token

If a project badge URL is accessed by someone who should not have access to it, you can renew the project badge’s unique token provided you’re a project admin. This invalidates any existing project badge URLs, and you’ll have to update all locations where the badge is being used.

To renew the badge token:

1. Retrieving projects.

2. In the top right corner, select Project Information.

3. In the Badges section, select Renew token.