TP1 : Découvrir Git et GitLab

Avant de commencer à coder, il est important de se familiariser avec les outils permettant d’organiser votre travail de programmation.

Objectifs¶

Le but de ce TP est de comprendre les points suivants :

• git clone <adresse du dépôt distant avec PAT> (Personal Access Token et Configuration de votre poste de travail)
• git status (Dépôt local)
• git add <nom du fichier> (Dépôt local)
• git commit -m "<message de commit>" (Dépôt local)
• git push (Dépôt local)
• git remote update (Dépôt distant et Synchronisation du dépôt local avec le dépôt distant)
• git pull (Dépôt distant et Synchronisation du dépôt local avec le dépôt distant)
• .gitignore (Ignorer des fichiers)

Ces points sont essentiels pour la suite donc il faut absolument les maîtriser !

Activation de votre compte GitLab¶

En tant qu’étudiant à l’IUT d’Orsay, vous disposez déjà d’un compte sur le GitLab de l’IUT.

Pour vous connecter, utilisez votre identifiant et votre mot de passe du département.

Personal Access Token¶

Pour établir une connexion sécurisée entre votre machine et le serveur GitLab de l’IUT, nous utiliserons un Personal Access Token (PAT) qui remplace l’ancien système de mot de passe.

Pour créer un PAT :

1. Accédez à votre profil en cliquant sur votre avatar (en haut à gauche) puis Edit profile.

2. Dans le menu de gauche, cliquez sur Access Tokens.

3. Ajouter un nouveau token en cliquant sur Add new token.

4. Donnez un nom au token qui reflète le poste de travail utilisé (par exemple IUTOrsay si vous travaillez sur un poste à l’IUT).

5. Définissez une date d’expiration d’un an (la durée maximale autorisée) à partir de la date d’aujourd’hui.

6. Sélectionnez tous les scopes.

7. Cliquez sur Create personal access token.

Création d’un dépôt distant¶

1. Créez votre premier projet/dépôt (repository) en cliquant sur le bouton + en haut à gauche.

2. Créez un projet vide avec le nom qualite-dev-s2-<prenom>-<nom> (par exemple qualite-dev-s2-hoang-la).

3. Pour l’URL du projet, choisissez votre login court Users et l’URL proposé par défaut.

4. Sélectionnez l’option de visibilité “Privé” pour votre projet et cochez l’option pour initialiser le projet avec un README.

5. Cliquez sur Create Project.

6. Si vous voyez les messages suivantes, vous pouvez les ignorer en cliquant sur Don’t show again pour SSH key et X pour Auto DevOps.

7. Parcourez le README par défaut proposé par GitLab.

Configuration de votre poste de travail¶

Votre projet a été créé sur le serveur de l’IUT. Maintenant, pour travailler sur ce projet depuis votre poste de travail local, vous devez d’abord le configurer.

1. Recopiez les lignes de code suivantes dans un terminal.

git config --global user.name "<Prénom> <Nom>"
git config --global user.email "<Email universitaire>"

Par exemple :

git config --global user.name "Hoang La"

Puis :

git config --global user.email "hoang.la@universite-paris-saclay.fr"

Ou :

git config --global user.email "hoang.la-tmp@universite-paris-saclay.fr"

Vous pouvez maintenant cloner votre dépôt distant pour le télécharger sur votre poste local : 2. Cliquez sur le bouton Code situé à droite.

3. Copiez l’URL sous l’option Clone with HTTPS.

4. Placez-vous dans votre répertoire de travail préféré (et ouvrez un terminal).

5. Saisissez la commande suivante, en collant l’adresse copiée et en rajoutant votre login ainsi que votre PAT aux emplacements appropriés.

git clone https://<votre login court>:<Personal Access Token>@git.iut-orsay.fr/<login du créateur du projet>/<nom du projet>.git

Par exemple :

git clone https://hla:glpat-1234thisIsYourPAT5678@git.iut-orsay.fr/hla/monprojet.git

git remote set-url origin https://hla:glpat-1234thisIsYourNewPAT5678@git.iut-orsay.fr/hla/monprojet.git

Dépôt local¶

Un répertoire portant le même nom (dépôt local) a maintenant été téléchargé sur votre machine.

1. Exécutez les commandes suivantes.

cd monprojet/
ls
git status

La commande ls vous permet d’afficher l’ensemble des fichiers dans le répertoire, tandis que git status montre l’état du dépôt. Pour l’instant, cette dernière commande devrait indiquer qu’il n’y a rien à valider et que votre copie de travail est propre (nothing to commit, working tree clean).

2. Que constatez-vous en exécutant les commandes suivantes ?

touch my-first-file.txt
git status

3. Ajoutez une ligne dans my-first-file.txt (par exemple Hello World!).

4. Demandez à Git de suivre la modification à my-first-file.txt en exécutant la commande suivante.

git add my-first-file.txt

5. Exécutez à nouveau la commande git status. Que vous indique-t-elle ?

6. Maintenant, pour créer un historique des modifications suivies (ici, le fichier my-first-file.txt avec la ligne Hello World!), vous devez valider (commit) ces changements et ajouter un message décrivant ces modifications en exécutant la commande git commit -m "<message de commit descriptif>".

Par exemple :

git commit -m "Premier commit de my-first-file.txt qui dit Hello World!"

7. Réexécutez git status pour vérifier l’état de votre dépôt. Que vous indique-t-elle ?

8. Exécutez git push.

9. Retournez sur GitLab et vérifiez que le dépôt distant correspond bien au dépôt local.

Dépôt distant¶

1. Cliquez sur my-first-file.txt.
2. Cliquez sur Edit.
3. Sélectionnez l’option Open in Web IDE.
4. Ajoutez une deuxième ligne à ce fichier (par exemple, Hi!).

Vous pouvez voir un 1 sur la barre à gauche, indiquant qu’un changement a été effectué. Si vous cliquez dessus, vous verrez un changement concernant le fichier my-first-file.txt et l’option pour sauvegarder et diffuser sur la branche main (Commit and push to ‘main’).

5. Ajoutez un message de commit.
6. Cliquez sur le bouton Commit and push to ‘main’.
7. Cliquez sur Continue lorsque l’on vous demande si vous souhaitez sauvegarder sur la branche par défaut (main).

Synchronisation du dépôt local avec le dépôt distant¶

Retournez sur votre dépôt local et supposons qu’un collaborateur a effectué des changements, puis les a diffusés sur le dépôt distant sans que vous en soyez informé.

1. Exécutez git status. Que remarquez-vous d’étrange ?

2. Exécutez git remote update, puis git status. Que voyez-vous maintenant ?

3. Exécutez git diff origin/main pour voir les différences entre les deux dépôts.

4. Pour synchroniser votre dépôt local avec le dépôt distant (qui, cette fois, est en avance), exécutez git pull.

5. Pour consulter l’historique des commits, exécutez git log. Pour quitter le log, appuyer sur q (pour ‘quit’).

Ignorer des fichiers¶

1. Créez un fichier hello-world.cpp (avec touch hello-world.cpp par exemple).

2. Ouvrez hello-world.cpp dans votre éditeur de code préféré et recopiez le code suivant.

#include <iostream>
using namespace std;
int main() {
    cout << "Hello World!" << endl;
    return 0;
}

3. Compilez le code avec g++ -o <nom du fichier> <nom du fichier>.cpp.

Par exemple :

g++ -o hello-world hello-world.cpp

4. Exécutez l’exécutable hello-world avec la commande ./hello-world.

Les exécutables font partie des fichiers que nous souhaitons ignorer.

5. Créez le fichier .gitignore.

6. Écrivez le nom de l’exécutable hello-world dans .gitignore.

7. Exécutez git add, git commit -m "<message>" et git push pour envoyer le fichier .gitignore sur le dépôt distant.

8. Exécutez git status. Qu’est-ce qui change par rapport à d’habitude ?

Pour finir...¶

Terminons ce TP par une petite réorganisation.

1. Créez un dossier TP1/ dans votre projet et bougez tout sauf .git, .gitignore et README.md vers ce dossier.

Vous allez maintenir ce projet pendant le reste du cours en créant des dossiers séparés pour chaque TP.

2. Revenez à la racine du projet et exécutez git add .

3. Validez les modifications suivies avec git commit.

J’ai oublié de mettre un message de commit...

Vous êtes ici parce que vous avez exécuté git commit sans spécifier de message avec l’option -m (git commit -m "<message>"). Git vous oblige donc à écrire un message en ouvrant la fenêtre suivante.

• Écrivez votre message de commit sur la première ligne.

Si vous êtes sur l’éditeur Nano (qui ressemble à l’écran au-dessus) :

• Appuyez sur Ctrl + X pour quitter.
• Appuyez sur y pour valider les modifications du message de commit.
• Appuyez sur Enter pour quitter la fenêtre.

Si vous êtes sur l’éditeur Vim (éditeur par défaut de Debian à l’IUT) :

• Appuyez sur Esc pour sortir du mode insertion.
• Écrivez :wq pour enregistrer le message et quitter la fenêtre.
• Appuyez sur Enter pour exécuter la commande :wq.

Vu que nous allons ignorer beaucoup d’exécutables dans le futur, pour éviter de modifier .gitignore à chaque fois, nous allons utiliser des expressions régulières pour ignorer les fichiers sans extensions (les exécutables).

4. Remplacez le code du fichier .gitignore avec le code suivant.

*
!*.*
!*/

**/*.exe
**/*.o

**/build/

*
!*.*
!*/
**/*.exe
**/*.o
**/build/

5. Exécutez add, commit et push pour synchroniser vos dépôts.

6. Ajoutez votre encadrant à votre projet en suivant les instructions ci-dessous.

• Cliquez sur Manage à gauche, puis sélectionnez Members.

• Cliquez sur Invite members en haut à droite.
• Ajoutez votre encadrant avec le rôle Maintainer, qui lui donne presque autant de droit sur le projet que le rôle Owner.

7. Revenez aux objectifs et cochez les points que vous avez maîtrisés. Pratiquez les commandes et les points que vous n’avez pas encore bien compris. Appelez votre encadrant si besoin.