Comment utiliser les labels et les issues

Quand utiliser ce guide

Utilise ce guide quand tu veux :

  • Créer et organiser des labels sur un dépôt
  • Assigner des labels à une issue pour la catégoriser
  • Filtrer les issues par label
  • Fermer automatiquement une issue depuis un message de commit ou une PR
  • Comprendre le système de labels à deux niveaux de gitrust

Pré-requis

  • Un dépôt gitrust avec le niveau d'accès Developer minimum

Comprendre les labels à deux niveaux

gitrust organise les labels en deux niveaux : classification et sujet.

  • Niveau 1 — Classification : la nature du ticket (bug, feature, docs, chore)
  • Niveau 2 — Sujet : la zone fonctionnelle concernée (auth, ci, ui, api)

Combiner les deux niveaux donne une issue catégorisée précisément : une issue avec bug + auth est un bug dans le module d'authentification. Le filtrage par combinaison de labels permet de retrouver rapidement les issues pertinentes.


Étapes

1. Accéder à la gestion des labels

Navigue vers /{owner}/{repo}/labels.

La page liste les labels existants avec leur couleur et leur description.

Page de gestion des labels

2. Créer un label

Sur la page des labels, remplis le formulaire en haut :

  • Nom : court, en minuscules, sans espaces (ex. bug, feature, auth, ci)
  • Couleur : choisis une couleur hexadécimale ou utilise le sélecteur
  • Description : optionnel — explique en une phrase quand appliquer ce label

Clique Créer le label.

Labels recommandés pour démarrer :

Label Niveau Couleur suggérée Usage
bug Classification #d73a4a (rouge) Comportement inattendu
feature Classification #0075ca (bleu) Nouvelle fonctionnalité
docs Classification #0052cc (bleu foncé) Documentation uniquement
chore Classification #e4e669 (jaune) Maintenance, dépendances
auth Sujet #7057ff (violet) Module authentification
ci Sujet #008672 (vert) Pipeline CI
api Sujet #e99695 (rose) API REST

3. Assigner des labels à une issue

Sur la page d'une issue (/{owner}/{repo}/issues/{num}), dans la barre latérale droite, clique sur Labels.

Sélectionne un ou plusieurs labels dans la liste déroulante. La sélection est appliquée immédiatement.

Ou depuis l'API :

curl -X POST \
  -H "Authorization: Bearer gr_pat_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"label_ids": [1, 3]}' \
  https://gitrust.example.com/api/v1/repos/owner/repo/issues/5/labels

4. Filtrer les issues par label

Sur la page des issues (/{owner}/{repo}/issues), clique sur le menu Labels dans la barre de filtres. Sélectionne un ou plusieurs labels — seules les issues portant ces labels s'affichent.

Pour combiner des filtres (ex. toutes les issues bug dans la zone auth) : sélectionne les deux labels dans le même filtre.

5. Fermer une issue automatiquement

Pour fermer automatiquement une issue lors de la fusion d'une PR ou d'un push sur main, utilise un mot-clé de fermeture dans :

  • Le message de commit (si poussé directement sur main)
  • La description de la PR (fermeture effective à la fusion)
  • Un commentaire de commit dans la branche

Mots-clés acceptés (insensibles à la casse) :

Mot-clé Exemple
closes closes #5
fixes fixes #5
resolves resolves #5

Exemple de message de commit :

git commit -m "corrige la validation email - fixes #5"

Après fusion de la PR contenant ce commit, l'issue #5 passe automatiquement au statut Fermée.


Variantes

Modifier ou supprimer un label

Sur /{owner}/{repo}/labels, chaque label a un bouton Modifier (pour changer le nom, la couleur ou la description) et un bouton Supprimer. La suppression retire le label de toutes les issues auxquelles il était assigné.

Labels suggérés automatiquement

gitrust peut suggérer des labels en fonction du contenu d'une issue. Cette suggestion s'affiche lors de la création d'une issue. Accepte ou ignore selon le contexte.


Voir aussi