Aller au contenu principal

Affiche SonarQube sur un composant

Chaque composant annoté montre la qualité de son code : une carte Qualité du code sur sa Vue d'ensemble, et un onglet SonarQube.

Comment faire​

1. Allume le plugin​

  1. Dans Administration, sous PLATEFORME, clique sur Plugins.
  2. Sur la carte SonarQube, allume l'interrupteur Activer SonarQube.

Si la carte dit Configurez d'abord l'intégration SonarQube, clique dessus : l'intégration s'ouvre dans Connexions de l'entreprise. Ajoute-la (Ajouter l'intégration SonarQube). Le plugin s'allume tout seul quand tu enregistres l'intégration : passe à l'étape 2.

2. Annote le composant​

Dans le catalog-info.yaml du composant, ajoute la clé de son projet SonarQube :

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: shop-api
  annotations:
    sonarqube.org/project-key: acme-shop-api
spec:
  type: service
  lifecycle: production
  owner: team-a
Où trouver la clé du projet ?

Dans SonarQube, ouvre le projet, puis Project Information : c'est la Project Key.

3. Vérifie​

Ouvre le composant dans Catalogue :

  • sur la Vue d'ensemble, la carte Qualité du code montre la quality gate, Bugs, Vulnérabilités, Code smells, Hotspots revus, Couverture et Duplications ;
  • l'onglet SonarQube montre les mêmes chiffres.

✅ C'est fait.

Tu as plusieurs SonarQube​

Commence l'annotation par la clé d'instance de l'intégration, puis /, puis la clé du projet :

metadata:
  annotations:
    sonarqube.org/project-key: prod/acme-shop-api

Ici, prod est la Clé de l'instance SonarQube de l'intégration du SonarQube de production.

Ce que ça affiche, et pour qui​

Toute personne qui peut ouvrir le composant voit la qualité de son code. Astrolabe lit SonarQube avec le jeton de l'intégration, le même pour tout le monde.

Un souci ? Voir Problèmes courants avec SonarQube.