1. Gestion de projet et documentation#
Ce premier module a pour objectif de créer un site web tout en se familiarisant avec l’utilisation de l’outil de gestion de version “Git”. Les différentes étapes réalisées pour atteindre les objectifs de ce module, ainsi que ceux des modules suivants, seront soigneusement documentées.
Premier contact avec Git#
Téléchargement#
La première étape est l’installation de Git, un outil de gestion de version. Pour ce faire, il suffit de visiter le site officiel de Git et de choisir la version adaptée à votre système d’exploitation. Utilisant personnellement Windows, j’ai opté pour la dernière version disponible de Git compatible avec cet environnement.
Mise en place#
Une fois Git téléchargé et installé en suivant les paramètres par défaut de l’installateur, l’étape suivante consiste à le configurer sur votre machine. Pour cela, ouvrez Git Bash et saisissez les commandes suivantes :
git config –global user.name “votre_nom_utilisateur” et git config –global user.email “votre_adresse_email@example.com”
Clé SSH#
Cette étape, bien qu’elle puisse paraître superflue, est essentielle car GitLab utilise le protocole sécurisé SSH pour gérer les échanges entre les fichiers locaux sur votre ordinateur et le serveur distant où ils seront hébergés. SSH repose sur un système de cryptographie basé sur une paire de clés : une clé publique, qui peut être partagée entre différents systèmes, et une clé privée, qui doit rester strictement confidentielle.
Pour générer ces clés nécessaires à la sécurisation des échanges entre votre machine locale et le serveur GitLab, ouvrez un terminal. Si vous avez installé Git, vous pouvez utiliser Git Bash. Ensuite, exécutez la commande suivante :
ssh-keygen
Cela générera une paire de clés, qui seront sauvegardées dans un fichier sur votre ordinateur. Par défaut, un emplacement vous sera proposé pour stocker ce fichier. Vous pouvez accepter l’emplacement suggéré ou indiquer un chemin spécifique.
Après avoir généré les clés, localisez le fichier où elles ont été enregistrées. Si vous êtes sur Windows, il peut être nécessaire d’afficher les dossiers cachés dans l’explorateur de fichiers, car ce fichier est généralement placé dans un répertoire caché (dont le nom commence par un point). Ouvrez le fichier contenant votre clé publique, reconnaissable par une longue chaîne de caractères commençant par “ssh-rsa”. Copiez cette clé.
Ensuite, ouvrez les paramètres de votre compte GitLab via un navigateur web. Cliquez sur votre photo de profil, sélectionnez “Modifier le profil”, puis recherchez l’onglet “Clé SSH” dans le menu latéral. Collez la clé publique copiée dans le champ prévu sous “Ajouter une clé SSH” et validez.
Git clone#
Maintenant que votre compte GitLab et votre ordinateur sont connectés et authentifiés, vous pouvez commencer à utiliser Git. La première chose à faire est de créer une copie du répertoire (repository) de votre projet sur votre ordinateur. Ce répertoire contient, par exemple, les fichiers de votre site web.
Actuellement, ces fichiers sont uniquement sur GitLab. Pour les récupérer, connectez-vous à votre compte GitLab, trouvez votre projet dans la liste et cliquez dessus. Une fois dans votre projet, cherchez un bouton bleu marqué “Clone”. Cliquez dessus, puis copiez l’URL qui s’affiche sous “Cloner avec SSH”.
Ensuite, ouvrez Git Bash dans un dossier vide où vous voulez mettre une copie de votre projet. Si vous êtes sur Windows, allez à l’endroit où vous voulez créer le dossier, faites un clic droit, puis cliquez sur “Open Git Bash here” (ouvrir Git Bash ici).
Dans Git Bash, tapez cette commande :
git clone git@gitlab.com:votre_lien.git
Remplacez “votre_lien” par l’URL de votre propre repository que vous avez copiée plus tôt.
Quand la commande est terminée, tous les fichiers de votre projet seront copiés sur votre ordinateur. Vous pourrez alors modifier ces fichiers avec l’éditeur de texte que vous préférez. C’est tout !
Commandes sur Git#
| Instruction | Description |
|---|---|
| Git pull | Cette commande permet de récupérer la dernière version du projet disponible sur le GitLab |
| Git add -A | ”” d’ajouter toutes les modifications effectuées pour le commit |
| Git commit -m “COMMENT TO DESCRIBE THE INTENTION OF THE COMMIT” | ”” soumettre les changements effectués localement créant ainsi une nouvelle version locale du projet et d’accompagner ces modifications d’un commentaire décrivant les modifications effectuées |
| Git push | ”” soumettre les modifications effectuées sur la version locale au serveur distant en vue de mettre à jour la version distante du projet |
Modifier les pages des modules du site web est très simple. Il vous suffit de changer les fichiers “.md” associés au module que vous voulez mettre à jour.
Issues#
Pour chaque module, une issue associée vous aide à vérifier que tout est bien documenté. Elle inclut une checklist des éléments à couvrir et une section pour noter vos apprentissages. Pour importer une issue, allez sur votre projet GitLab, cliquez sur “Programmation” > “Tickets”, puis sur “Importer des tickets”. Sélectionnez le fichier CSV du module correspondant, importez-le, et retrouvez-le ensuite dans l’onglet “Tickets”.