Introduction à Git

Ce guide a pour objectif de vous présenter le fonctionnement, la configuration et l'utilisation du service Git intégré à Tuleap. Nous nous concentrerons sur les fonctionnalités offertes par Tuleap pour gérer vos dépôts de code source.

Dans Tuleap, le service Git s’intègre nativement aux outils de suivi de projet. Cette intégration permet de relier de manière fluide les commits, les branches, les pull requests et les artifacts de la plateforme.

Cette traçabilité complète permet à chaque membre de l'équipe de comprendre le contexte d'une modification de code, de naviguer facilement d'une tâche à un commit, et de garantir que chaque changement est justifié et validé.

Info pratique

Il est également possible d'intégrer Tuleap avec des dépôts hébergés sur une instance GitLab externe pour bénéficier d'une traçabilité complète entre vos artifacts Tuleap et votre code. Cette intégration permet de combiner la gestion de projet de Tuleap avec les fonctionnalités de CI/CD de GitLab. Cette fonctionnalité est décrite plus en détail dans la page de documentation complète relative au service Git.

Pour utiliser ce service, il vous faut activer le service “Git” dans l’administration de votre instance Tuleap et dans l’administration de votre projet.

Prérequis : se familiariser avec Git

Apprendre les concepts de Git

Avant de manipuler les outils, comprendre le fonctionnement de Git est essentiel.

Le livre "Pro Git", rédigé par Scott Chacon et Ben Straub et accessible en ligne gratuitement, est la ressource la plus complète pour apprendre le fonctionnement de Git, de la base aux concepts les plus avancés comme les branches et les fusions.

Choisir un client Git

Un client Git est le logiciel que vous installerez sur votre ordinateur pour communiquer avec le dépôt hébergé sur Tuleap.

• Clients graphiques (GUI) : il existe de nombreuses options pour Windows, macOS et Linux. Des outils comme Sourcetree, GitKraken, ou GitHub Desktop offrent une interface visuelle pour simplifier les opérations Git.

• Ligne de commande (client git) : la méthode la plus directe et universelle. Le client s'installe via le gestionnaire de paquets de votre distribution ou en le téléchargeant depuis le site officiel de Git.

• Également, la plupart des environnements de développement (IDE) modernes intègrent un support pour Git, soit nativement, soit via des extensions. Pensez à vérifier les options d’installation sur votre IDE favori.

Créer un nouveau dépôt Git

La première étape pour utiliser le service est de créer un dépôt qui hébergera votre code.

La création de nouveaux dépôts est une opération simple, réalisable par l'administrateur du projet ou l'administrateur du service Git.

1. Rendez-vous dans le service Git de votre projet Tuleap.

2. Cliquez sur le bouton de création d'un nouveau dépôt.

3. Insérez le nom souhaité pour le dépôt, puis cliquez sur “Ajouter un dépôt”.

Une fois créés, les dépôts apparaissent dans la liste des dépôts du projet. Vous pouvez créer autant de dépôts que vous le souhaitez : ils sont tous gérés localement par la plateforme Tuleap.

Explorer un dépôt

En sélectionnant un dépôt dans la liste, vous pouvez accéder à sa page principale et consulter toutes les informations qui y sont liées.

Sur cette page, vous retrouverez plusieurs informations clés :

• Le nom du dépôt : celui-ci affiché en haut de la page.

• Les fichiers : cette section contient tous les fichiers associés au dépôt. Chaque fichier peut être téléchargé ou visualisé selon les besoins de l'utilisateur.

• Le nombre de pull requests : un compteur indique le nombre de pull requests en attente de revision.

Naviguer dans l'historique des commits

Par défaut, la zone d'information affiche le journal des commits (shortlog) de la branche principale (généralement master ou main).

Vous pouvez facilement sélectionner la branche que vous souhaitez inspecter pour afficher son historique spécifique.

En cliquant sur l'onglet "Commits", vous accéderez à une vue plus détaillée de l'historique complet de la branche sélectionnée.

Pour obtenir toutes les informations liées à une modification précise, il suffit de cliquer sur un commit dans la liste. Vous pourrez alors consulter :

• L'auteur et le commiteur.

• Les identifiants uniques (commit, arbre, parent).

• Le message de commit détaillé.

• Les éventuelles références à des artifacts Tuleap.

• La liste des fichiers impactés.

Les changements de code peuvent être visualisés sous forme de "diff", soit de manière globale, soit fichier par fichier.

Cloner le dépôt

Pour commencer à travailler sur le code, vous devez d'abord créer une copie locale du dépôt hébergé sur Tuleap.

Pour ce faire, vous pouvez cloner le dépôt en utilisant soit le protocole HTTPS, soit le protocole SSH. Votre choix déterminera la méthode d'authentification requise.

• Via HTTPS  : cette méthode nécessite une "Clé d'accès personnelle" pour vous authentifier. Vous devez, au préalable, générer cette clé depuis les préférences de votre profil utilisateur sur  Tuleap. Lors de l'opération de clonage, vous devrez utiliser votre nom d'utilisateur et la clé d'accès personnelle en guise de mot de passe.

• Via SSH : l'utilisation du protocole SSH est souvent plus pratique et rapide. Pour cette méthode, il est impératif d'avoir configuré au préalable une clé SSH publique dans votre profil utilisateur Tuleap. Une fois votre clé publique ajoutée à votre compte, vous pourrez cloner le dépôt sans avoir à saisir vos identifiants à chaque opération.

Gérer la revue de code avec les Pull Requests

Les Pull Requests (PR) sont l'outil central de Tuleap pour la revue de code. Elles permettent à votre équipe de discuter des changements proposés avant de les intégrer dans une branche principale.

Cette fonctionnalité sera disponible uniquement si le plugin “Pull request” est installé et activé

Créer une Pull Request

1. Depuis la page du dépôt, cliquez sur le bouton “Créer une pull request”.

2. Sélectionnez la branche source (celle contenant vos changements) et la branche de destination (celle où vous souhaitez fusionner).

Une fois créée, la PR apparaît dans la liste des Pull Requests en attente.

Faire la revue de code

Cliquez sur une PR pour accéder à sa page de détails. Vous y trouverez :

• Le demandeur de la PR.

• Un résumé des changements.

• Un espace pour les commentaires généraux.

Les membres du projet peuvent discuter des changements, et naviguer dans l'onglet "Changements" pour voir toutes les modifications. Tuleap permet de commenter une ligne de code spécifique en cliquant simplement sur son numéro, facilitant ainsi des retours précis et contextualisés.

Finaliser une Pull Request

À l'issue de la revue, deux options principales s'offrent à vous :

• Abandonner la PR si les changements ne sont pas retenus.

• Intégrer (merger) la PR pour fusionner les modifications dans la branche cible.