Managing your project as a developer

This page explains how to connect your project to SonarQube for IDE, generate a token, subscribe to notifications, and use a project badge.

This page explains various procedures you can perform on your project without being a project admin.

Connecting your project to SonarQube for IDE

SonarQube for IDE is a free IDE extension that integrates with SonarQube Cloud using connected mode. This way, SonarQube for IDE can catch issues immediately, right in the IDE, before you even commit them.

Check the SonarQube for IDE documentation for the details about setting up Connected Mode:

Generating a token for your project analysis

From the Team plan, see Managing Scoped Organization Tokens.

With the Free plan, seeManaging Personal Access Tokens.

Subscribing to notifications on project events

You can choose to receive email notifications when specific events occur in your project. See Subscribing to notifications.

Marking a project as favorite

Favorite projects are displayed on My projects page.

When you create a project, it’s automatically marked as favorite.

To mark a project as a favorite:

  1. Retrieve the project. See Retrieving projects for more information.

  2. In the top of the left-side panel, select the star icon.

SonarQube Cloud provides an easy way to mark your favorite projects. From the Project's Overview page, select the star in the upper left corner.

Alternatively, you can select or unselect the star in a list of projects as illustrated below.

SonarQube Cloud also lets you mark your favorite projects from the My Projects page. Simply select the start next to the project name.

Using a project badge

If you have project access, you can include dynamic SonarQube Cloud badges on your web pages to display information about the project such as:

  • The current value of specific metrics.

  • The current quality gate status.

  • The fact that you are using SonarQube Cloud.

  • That your AI Code Assurance has been analyzed, available for Team and Enterprise plans.

Markdown snippets and simple image URLs are provided to generate the badge code.

To generate the code of your dynamic project badge:

  1. Retrieve the project. See Retrieving projects for more information.

  2. In the left navigation bar, select Information.

  3. In the Badges section:

    1. Select the information type you want to display:

      • Metric value

      • Quality gate status

      • SonarQube Cloud user

    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 depending on how you want to include your badge.

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

From your SonarQube Cloud project Information page, go to the Badges section to define metrics and grab the markdown snippet that links to the correct image URL for badges to display on your website.

Last updated

Was this helpful?