Skip to content

🧾 Issues

🐣 Premières étapes simples (issue, MR, ...)

Une fois connecté :

  1. Créer un nouveau projet simple aka "Blank project"
    • Il existe des projets templates fournis par défaut par Gitlab, vous pouvez également en créer facilement 👉 🔗 Official documentation
  2. Créer une première issue "📃 Update README.md"
    • L'objectif de cette issue doit être d'ajouter un schéma mermaid
  3. A partir de cette issue, créer une Merge Request et une branche pour cette issue
    • Par défaut, l'issue est préfixée par Draft pour indiquer qu'elle est en cours
  4. En utilisant le WebIDE fourni dans Gitlab, modifier le fichier README.md sur le branche de l'issue et commiter
    • ajoute dans le fichier un bloc de code ```mermaid 👉 snippet
  5. Enfin, accepter la MR pour que le code soit mergé sur la branche main via le bouton Merge
    • Il faut indiquer que la MR est prête en supprimant le prefix Draft de l'intitulé de la MR ou via l'action Mark as ready disponible via les ...

Success

  • Le fichier README.md sur main est à jour avec le schéma mermaid ✅
  • L'issue et la merge request sont fermées ✅

Si l'issue n'a pas été fermée, c'est qu'il vous a manqué l'indication Closes #1 dans la description de la MR. Normalement, cela est positionné automatiquement si vous créez la MR depuis l'issue.

📋 Templates

Laisser les zones de texte des issues et des merge requests "libres" n'est pas forcément une bonne pratique. Avec GitLab, on peut facilement créer des templates d'issues et de merge requests pour guider les utilisateurs.

Pour cela, via le WebIDE par exemple, il suffit de:

  • créer un répertoire/dossier .gitlab à la racine du projet
  • dans ce répertoire/dossier, créer 2 sous-répertoires issue_templates et merge_request_templates
  • le dans le répertoire/dossier issue_templates, créer un fichier my_template.md avec le contenu du snippet
  • le dans le répertoire/dossier merge_request_templates, créer un fichier my_template.md avec le contenu du snippet
  • commiter

Renouveler l'étape 1 de création d'issue et de merge request.

Success

  • Vous pouvez choisir votre template pour l'issue depuis le menu Description
  • Vous pouvez choisir votre template pour la MR depuis le menu Description
    • ⚠️ Cela supprime le Closes #2 qui a été positionné automatiquement pour clorer l'issue une fois la MR validée. Pensez à le remettre

🔖 Labels

Il peut être pratique également de pouvoir trier les issues, merge requests de son projet. Pour cela, GitLab propose le mécanisme de label.

Créons nos labels pour suivre l'avancement de nos travaux par exemple.

Depuis le menu Manage > Labels, créer 4 labels:

  • ToDo ⏳
  • InProgress 🚧
  • ToReview 🛂
  • Done ✅

Une fois créés, instancier 4 nouvelles issues avec chacune un label différent.

Dans notre liste d'issue, on voit bien les labels apparaître. Mais cela n'est pas très pratique pour suivre globalement notre backlog.

On va donc créer un tableau de suivi via le menu Plan > Issue boards. Par défaut, GitLab crée 2 colonnes pour les issues ouvertes et fermées.

  • masquer ces 2 colonnes
  • ajouter les 4 colonnes relatives aux labels créés

Success

Les issues sont bien triées par colonne

Si on déplace une issue d'une colonne à une autre, automatiquement le label de nouvelle colonne est ajouté et celui de l'ancienne est supprimé

🪪 Badges décoratifs

On peut associer décorer le projet avec des badges visibles sur la page d'accueil du projet. Cela est pratique pour avoir des informations sur le statut du pipeline, la couverture de tests, la licence, ...

Depuis le menu Settings > General > Badges, ajouter le badge de statut du pipeline

Success

Le badge du statut du pipeline apparait sur la page d'accueil