Backstage SonarQube Plugin

yarn --cwd packages/app add @backstage-community/plugin-sonarqube @backstage-community/plugin-sonarqube-react

import React from 'react';
import Grid from '@material-ui/core/Grid';
import { EntityAboutCard, EntityLayout, EntitySwitch } from '@backstage/plugin-catalog';
import { RELATION_HAS_PART } from '@backstage/catalog-model';

import { EntitySonarQubeCard, SonarQubeRelatedEntitiesOverview } from '@backstage-community/plugin-sonarqube';
import { isSonarQubeAvailable } from '@backstage-community/plugin-sonarqube-react';

const MISSING_ANNOTATION_READ_MORE_URL =
  'https://backstage.io/docs/features/software-catalog/descriptor';

const overviewContent = (
  <Grid container spacing={3} alignItems="stretch">
    <Grid item md={6}>
      <EntityAboutCard variant="gridItem" />
    </Grid>

    <EntitySwitch>
      <EntitySwitch.Case if={isSonarQubeAvailable}>
        <Grid item md={6}>
          <EntitySonarQubeCard
            variant="gridItem"
            missingAnnotationReadMoreUrl={MISSING_ANNOTATION_READ_MORE_URL}
          />
        </Grid>
      </EntitySwitch.Case>
    </EntitySwitch>
  </Grid>
);

export const systemPage = (
  <EntityLayout>
    {/* your other routes */}

    <EntityLayout.Route path="/sonarqube" title="Code Quality">
      <SonarQubeRelatedEntitiesOverview relationType={RELATION_HAS_PART} entityKind="component" />
    </EntityLayout.Route>
  </EntityLayout>
);

import { createApp } from '@backstage/app-defaults';
import sonarQubePlugin from '@backstage-community/plugin-sonarqube/alpha';

export const app = createApp({
  features: [
    sonarQubePlugin,
  ],
});

yarn --cwd packages/backend add @backstage-community/plugin-sonarqube-backend

import { createRouter } from '@backstage-community/plugin-sonarqube-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';

export default async function createPlugin(
  env: PluginEnvironment,
): Promise<Router> {
  return await createRouter({
    logger: env.logger,
    config: env.config,
    discovery: env.discovery,
    tokenManager: env.tokenManager,
  });
}

// add this near the other plugin imports
import sonarqube from './plugins/sonarqube';

// inside the main function after you create the env for the backend
const sonarqubeEnv = useHotMemoize(module, () => createEnv('sonarqube'));

// add this where you wire up other routers
apiRouter.use('/sonarqube', await sonarqube(sonarqubeEnv));

sonarqube:
  instances:
    - name: default
      baseUrl: https://sonarcloud.io
      # organization is only for SonarCloud
      # organization: your_org
      # token is optional
      # token: ${SONARQUBE_TOKEN}

sonarqube:
  instances:
    - name: default
      baseUrl: https://sonarqube.mycompany.example
      # token is optional
      # token: ${SONARQUBE_TOKEN}

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: my-service
  annotations:
    sonarqube.org/project-key: YOUR_INSTANCE_NAME/YOUR_PROJECT_KEY
spec:
  type: service
  owner: team-a
  lifecycle: production