feat: Add SonarCloud integration

Author: ThomasVitale

app-config.yaml

@@ -110,13 +110,9 @@ catalog:
   locations:
     # Users and Groups
     - type: file
-      target: ../../demo-catalog/organizations/organization-kadras.yml
+      target: ../../demo-catalog/organizations/organizations.yml
       rules:
         - allow: [Group, Location, User]
-    - type: file
-      target: ../../demo-catalog/organizations/organization-guest.yml
-      rules:
-        - allow: [Group, User]
 
     # Templates
     - type: file
@@ -164,3 +160,7 @@ search:
       highlightAll: false # If true the whole document will be used as the headline, ignoring the preceding three parameters. The default is false.
       maxFragments: 0 # Maximum number of text fragments to display. The default value of zero selects a non-fragment-based headline generation method. A value greater than zero selects fragment-based headline generation (see the linked documentation above for more details).
       fragmentDelimiter: ' ... ' # Delimiter string used to concatenate fragments. Defaults to " ... ".
+
+sonarqube:
+  baseUrl: https://sonarcloud.io
+  apiKey: ${SONARCLOUD_TOKEN}

demo-catalog/organizations/organizations.yml

@@ -0,0 +1,11 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: organizations
+  description: A collection of Organizations and Users
+spec:
+  targets:
+    - ./organization-arconia.yml
+    - ./organization-kadras.yml
+    - ./users.yml

demo-catalog/organizations/user-thomas-vitale.yml renamed to demo-catalog/organizations/users.yml

@@ -15,6 +15,7 @@
   },
   "dependencies": {
     "@backstage-community/plugin-github-actions": "^0.6.22",
+    "@backstage-community/plugin-sonarqube": "^0.8.2",
     "@backstage/app-defaults": "^1.5.11",
     "@backstage/catalog-model": "^1.7.0",
     "@backstage/cli": "^0.27.1",

packages/app/package.json

@@ -57,12 +57,15 @@ import {
 
 import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
 import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
+import { EntitySonarQubeCard } from '@backstage-community/plugin-sonarqube';
 
 import {
   EntityKubernetesContent,
   isKubernetesAvailable,
 } from '@backstage/plugin-kubernetes';
 
+const MISSING_ANNOTATION_READ_MORE_URL = 'https://backstage.io/docs/features/software-catalog/descriptor';
+
 const techdocsContent = (
   <EntityTechdocsContent>
     <TechDocsAddons>
@@ -132,6 +135,9 @@ const overviewContent = (
     <Grid item md={6}>
       <EntityAboutCard variant="gridItem" />
     </Grid>
+    <Grid item md={6}>
+      <EntitySonarQubeCard variant="gridItem" missingAnnotationReadMoreUrl={MISSING_ANNOTATION_READ_MORE_URL} />
+    </Grid>
     <Grid item md={6} xs={12}>
       <EntityCatalogGraphCard variant="gridItem" height={400} />
     </Grid>

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

@@ -16,6 +16,7 @@
     "build-image": "docker build ../.. -f Dockerfile --tag backstage"
   },
   "dependencies": {
+    "@backstage-community/plugin-sonarqube-backend": "^0.2.23",
     "@backstage/backend-defaults": "^0.5.0",
     "@backstage/config": "^1.2.0",
     "@backstage/plugin-app-backend": "^0.3.74",

packages/backend/package.json

@@ -48,4 +48,7 @@ backend.add(import('@backstage/plugin-search-backend-module-techdocs/alpha'));
 // kubernetes
 backend.add(import('@backstage/plugin-kubernetes-backend/alpha'));
 
+// other plugins
+backend.add(import('@backstage-community/plugin-sonarqube-backend'));
+
 backend.start();