The Adaptavist Group LogoDocumentation

SonarQube Plugin

This page helps you generate an access token for SonarQube and configure the necessary settings to integrate SonarQube with your developer platform.

Generating a Personal Access Token SonarQube

If available, use a service account for this task.

  1. Open your SonarQube instance, and log in to your account.
  2. Click your profile image or avatar at the top right corner, then select My Account from the dropdown menu.
  3. Click the Security tab.
  4. In the Generate Tokens section, enter a name for your token, such as Venue.sh Token.
  5. From the Type dropdown, select Global Analysis Token.
  6. Click Generate.
    A new token appears.
  7. Copy the token to your clipboard.
    Tip:

    Make sure you save the token in a secure place. You won't be able to see it again!

Configuring the SonarQube Plugin in Venue.sh

  1. In the Venue.sh app, click Plugins in the left-side navigation.
  2. Find SonarQube, then click Enable Plugin.
  3. Enter the values for the following three fields:
    • API BaseURL: The URL for the SonQube API.
      • Format: https://<your sonarqube instance url>/api
      • Example: https://your.sonarqube.instance.com/api
    • Token: The token you generated in the previous section.
    • Base URL: The base URL for your SonarQube instance.
      • Format: https://<your sonarqube instance URL>
      • Example: https://your.sonarqube.instance.com
  4. Click Enable.

Component Setup SonarQube

To connect your SonarQube project, add the following annotation to your component catalog-info.yaml file:
metadata:
  annotations:
    sonarqube.org/project-key: [YOUR_PROJECT_KEY]

Search documentation

Start typing to search the docs.