Aller au contenu principal

Afficher Codacy sur un composant

Chaque composant annoté montre sa note Codacy sur sa vue d'ensemble, et ses problèmes dans un onglet. La carte de Administration › Plugins dit : La note Codacy d'un composant sur sa vue, ses problèmes dans un onglet.

Deux étapes : allumer le plugin, annoter le composant.

1. 🔌 Allumer le plugin​

  1. Dans Administration, sous PLATEFORME, clique sur Plugins.

  2. Sur la carte Codacy, clique sur l'interrupteur Activer Codacy.

L'interrupteur est grisé ?

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

2. 🏷️ Annoter le composant​

Dans le catalog-info.yaml du composant, nomme le dépôt comme Codacy le connaît : le fournisseur Codacy (gh pour GitHub, gl pour GitLab, bb pour Bitbucket), l'organisation, puis le dépôt.

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: shop-api
  annotations:
    codacy.com/project-slug: gh/acme/shop-api
spec:
  type: service
  lifecycle: production
  owner: group:default/platform-team

✅ Vérifier​

Attends quelques minutes que le catalogue lise le fichier, puis ouvre le composant depuis Catalogue. Sans l'annotation, le composant n'a ni carte Codacy sur sa vue d'ensemble, ni onglet Codacy. Avec l'annotation, la carte et l'onglet montrent la note et les problèmes. Cette partie n'a pas été vérifiée sur une instance.

✅ C'est tout !