backstage/plugins/sonarqube

SonarQube Plugin

The SonarQube Plugin displays code statistics from SonarCloud or SonarQube.

Getting Started

1. Install the SonarQube Plugin:

# packages/app

yarn add @backstage/plugin-sonarqube

2. Add plugin to the app:

// packages/app/src/plugins.ts

export { plugin as SonarQube } from '@backstage/plugin-sonarqube';

3. Add the SonarQubeCard to the EntityPage:

// packages/app/src/components/catalog/EntityPage.tsx

import { SonarQubeCard } from '@backstage/plugin-sonarqube';

const OverviewContent = ({ entity }: { entity: Entity }) => (
  <Grid container spacing={3} alignItems="stretch">
    // ...
    <Grid item xs={12} sm={6} md={4}>
      <SonarQubeCard entity={entity} />
    </Grid>
    // ...
  </Grid>
);

4. Add the proxy config:

   Provide a method for your Backstage backend to get to your SonarQube API end point.

SonarCloud

# app-config.yaml

proxy:
  '/sonarqube':
    target: https://sonarcloud.io/api
    allowedMethods: ['GET']
    headers:
      Authorization: Basic ${SONARQUBE_AUTH}
      # Content: 'base64("<api-key>:")' <-- note the trailing ':'
      # Example: bXktYXBpLWtleTo=

SonarQube

# app-config.yaml

proxy:
  '/sonarqube':
    target: https://your.sonarqube.instance.com/api
    allowedMethods: ['GET']
    headers:
      Authorization: Basic ${SONARQUBE_AUTH}
      # Environmental variable: SONARQUBE_AUTH
      # Value: 'base64("<sonar-auth-token>:")'
      # Encode the "<sonar-auth-token>:" string using base64 encoder.
      # Note the trailing colon (:) at the end of the token.
      # Example environmental config: SONARQUBE_AUTH=bXktYXBpLWtleTo=
      # Fetch the sonar-auth-token from https://sonarcloud.io/account/security/

sonarQube:
  baseUrl: https://your.sonarqube.instance.com

5. Get and provide SONARQUBE_AUTH as an env variable (https://sonarcloud.io/account/security or https://docs.sonarqube.org/latest/user-guide/user-token/)

6. Run the following commands in the root folder of the project to install and compile the changes.

yarn install
yarn tsc

7. Add the sonarqube.org/project-key annotation to the catalog-info.yaml file of the target repo for which code quality analysis is needed.

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: backstage
  description: |
    Backstage is an open-source developer portal that puts the developer experience first.
  annotations:
    sonarqube.org/project-key: YOUR_PROJECT_KEY
spec:
  type: library
  owner: CNCF
  lifecycle: experimental