Table of Contents

TD sur le contrôle de version (Hands-on Git)

Basé sur le TD élaboré par Cyril Cecchinel

Et l'aide de Open Classroom pour gérer les configurations.

Objectifs du TD :

Un logiciel de contrôle de version permet de conserver un historique des modifications apportées sur des fichiers tout en offrant la possibilité de revenir à une version antérieure. Il existe des logiciels de contrôle de version centralisés et décentralisés.

Dans le cadre des cours de Conception et de Méthodologie de la production d’applications, nous allons utiliser Git.

AVANT TOUT

En ligne de commande avec l'outil Git: Lancez la commande:

 git config --global http.sslVerify false 

Retrouver le fichier de configuration .gitconfig situé dans votre répertoire personnel.

Visualiser son contenu. Si besoin, configurer GIT pour que les commits se fassent bien à votre nom :

 git config --global user.name "prenom Nom"

Puis votre e-mail :

 git config --global user.email moi@email.fr

Créer un nouveau dépôt

Pour commencer à travailler avec Git, il y a deux solutions :

Pour l'instant, nous allons prendre la 1e option. Mais par la suite, vous travaillerez de manière collaborative et donc nous prendrons la 2e option.

A Noter, que si vous travaillez sous Github ou BitBucket, en général, on crée le dépôt sur le site puis on le clone.

  1. Créer un répertoire myRepo (c'est le répertoire où vous voulez travailler).
  2. Initialiser le dépôt :
     git init 

Git comme historique des modifications

  1. Créer un fichier Menu.txt contenant les plats de votre restaurant favori, ligne par ligne.
    Salade norvégienne
    Œufs fauchés
    Steak tartare
    Filet de dorade
    Profiteroles
  2. Comment interprétez-vous le résultat de la commande suivante
     git status 
  3. Ajoutez le fichier Menu.txt comme git vous l'a dit :
     git add Menu.txt
  4. Réinterprétez le résultat de la commande git status.
  5. Le fichier Menu.txt est maintenant prêt à être versionné.
     git commit -m "construction de la carte" 

    ou

     git commit 

    1) Quel message avez-vous en retour?

  6. Que donne la commande git status ?
  7. Apportez quelques modifications au fichier Menu.txt. Essayez de commiter ces modifications. Que se passe-t-il ? En vous aidant de la documentation accessible en tapant git help commit, versionnez ces modifications (avec un message décrivant le changement) 2)
  8. Affichez l’historique des modifications du dépôt.
     git log 

    Et pour voir les modifications apportées par le dernier commit

     git log -p  -1 

    et savoir qui fait quoi

     git log --stat 

    ou

     git log --pretty=format:"%h - %an, %ar : %s"

    etc.

  9. En utilisant git diff , visualisez les modifications effectuées entre le premier commit et le second commit. Par exemple
     git diff 71cfcd6 0c24491 

    . Attention l'ordre des commits modifie le résultats (un- devient un +).

  10. Modifiez plusieurs fois le Menu afin d’en plusieurs versions.
  11. Le dernier plat ajouté ne vous plait finalement pas. Il existe deux manières de revenir à une version antérieure : de manière temporaire ou définitive.
  12. Exécuter git log et récupérez le hash (HASH) du commit où vous souhaitez revenir en arrière.
    1. Pour revenir en arrière de manière temporaire, exécutez
       git checkout HASH
      1. Vérifiez que votre fichier Menu.txt est dans son état antérieur.
      2. Revenez au dernier commit (HEAD) en exécutant
         git checkout master
    2. Pour revenir en arrière de manière définitive, et donc supprimer tout ce que vous avez fait depuis ce moment :
       git reset --hard HASH 
      1. Dans git log, vérifiez que tout ce que vous aviez effectué depuis ce commit a été effacé.

Branches de développement

Sauf indication contraire, vous ajouterez les plats séquentiellement dans le menu (les uns après les autres).

Vous êtes chargé(e) d’introduire des plats végétariens dans le menu du restaurant. Ces plats n’ayant pas encore été validés par la cuisine et la direction du restaurant, vous souhaitez travailler sur la carte sans casser la carte existante. La notion de branche permet de passer instantanément d’une version « stable » (branche « master » créée par défaut) du projet à une « version en cours de développement » (n’importe quelle autre branche que « master »)

  1. Jusqu'ici vous avez travaillé sur une seule branche « master » : c’est la branche principale, celle qui en général contient le « vrai » code source de votre projet. Pour voir toutes vos branches
    git branch 

    3)

  2. Créez une branche « vegetarien » dans votre dépôt Git.
     git branch vegetarien 
  3. Vérifiez que vous êtes bien dans la branche Master par la commande
    git branch 
  4. Basculez dans la branche vegetarien
     git checkout vegetarien
  5. Vérifiez dans quelle branche vous êtes
  6. Ajoutez deux/trois plats végétariens au menu et commitez au fur et à mesure les modifications.
  7. Fermer votre fichier.
  8. Observez l’historique des modifications du dépôt, que remarquez-vous ?
  9. Revenez à la carte principale (branche « master ») et observez l’historique des modifications, que remarquez-vous ?
  10. Ajoutez un plat non-végétarien au menu de la branche master. Commitez la modification.
  11. Le cuisinier et le directeur du restaurant sont satisfaits de vos propositions de plat et souhaitent maintenant les ajouter au menu principal. Fusionnez (« merge ») la branche « vegetarien » à la branche « master ».
    git merge vegetarien 

    Que se passe-t-il ? Ouvrez le fichier Menu.txt et vérifiez que la fusion s'est bien passée.

  12. Créez une branche « japonais »
     git checkout -b japonais 
  13. Ajoutez des plats japonais en commitant au fur et à mesure les modifications et retirer des plats de viande.
  14. Revenez sur la branche « master » et fusionnez la branche « japonais ». Regardez le contenu du fichier Menu.txt et l’historique de modifications du dépôt. Y a-t-il eu un conflit ? Pourquoi ?
  15. Si vous avez un conflit, résolvez le conflit de manière à ajouter tous les plats situés entre les balises de conflit (««< et »»>). Commitez le changement (et donc la fusion) en tapant « git commit –a »
  16. Modifiez le contenu de la branche japonais.
  17. Supprimer la branche japonais. Que se passe-t-il?
     git branch -d japonais 
    1. Supprimez les branches « vegetarien » et « japonais ».

Synchronisation de votre répertoire

Jusqu’à présent, vous avez pu expérimenter Git pour gérer localement vos versions. Nous allons maintenant nous intéresser au développement collaboratif de fichier sources. Pour cette partie, mettez vous avec votre groupe de méthodologie.

  1. Si votre dépôt est vide, UN étudiant :
    1. Récupérer l'adresse https de votre dépôt (onglet dépôt à droite)
    2. En vous plaçant dans le bon répertoire :
       
      git init
      touch readme.txt
      git add readme.txt
      git commit -m 'Initializing depot repository'
      git remote add origin URL
      git push -u origin master
  2. Visualisez les références distantes
     git remote 

    La nouvelle référence à origin vient de la ligne de commande git remote add [nomcourt] [url]

    1. Visualisez les URL associées aux références distantes
      git remote -v 
  3. (TOUS) En suivant lesinstructions de la Forge IUT, clonez le dépôt git associé à votre groupe.
    1. Récupérer l'adresse https de votre dépôt (onglet dépôt à droite)
    2. Cloner
       git clone URL
  4. Placez vous dans le dépot.
  5. Chaque personne du groupe participe :
    1. (Personne A)
      1. Créez un fichier index.html reprenant le code ci-dessous :
        <html>
        <head>
        <title>Demo</demo>
        </head>
        <body>
        </body>
        </html>
      2. Ajoutez le fichier au dépôt git et commitez le fichier. Envoyez ensuite le commit vers le dépôt distant :
         git push origin master
    2. (Tous sauf A)
      1. Visualiser l'état du dépôt distant
         git remote show origin 
      2. Synchroniser votre dépôt git avec la commande
         git pull 
  6. (Un développeur autre que A)
    1. Modifiez le fichier index.html afin d’ajouter du texte entre les balises body.
    2. Commitez les modifications et envoyez-les vers le dépôt distant.
  7. (TOUS) Synchroniser votre dépôt git avec la commande git pull.
  8. (Personne A)
    1. Modifiez le titre de la page Web et
    2. commitez/envoyez les modifications.
  9. (Personne B) (SANS SYNCHRONISER LE DEPOT)
    1. Modifiez le titre de la page Web
    2. commitez/envoyez les modifications. Que se passe-t-il ? Remédiez au conflit.

Tags

Git donne la possibilité d’étiqueter un certain état dans l’historique comme important grâce à un « tag ». Ces tags sont couramment utilisés pour marquer des états de publication (e.g. v1.0, v1.1, …). Deux types de tags sont disponibles :

Dans le cadre de cette matière, nous utiliserons que des tags légers. Pour plus d’informations sur le mécanisme de tags annotés, voir les ressources.

  1. Reprenez votre fichier « Menu.txt » et apportez-y des modifications. La nouvelle version obtenue correspondra à la carte qui sera publiée au guide Michelin 2017. Pour marquer cette importance, nous allons associer le tag « michelin » au prochain commit : Créez une étiquette ‘michelin17’
     git tag michelin17
  2. Listez les étiquettes disponibles
     git tag 

Attention ! Les tags ne sont pas poussés automatiquement sur un serveur distant. Il faut demander explicitement à pousser les étiquettes après les avoir créées localement (cf. cheat sheet) ou utiliser l’option –-tags

Cheat-Sheet

Création/Synchronisation

 $ git init myRepo 
Initialized empty Git repository in /private/tmp/myRepo/.git/
  $git clone <URL du repo Git à cloner> 
$ git remote add origin <URL du repo Git>
 $ git push master origin
 $ git pull

Commiter des modifications

 $ git status 
 $ git add <Fichier à ajouter> 
 $ git commit -m "Premier commit"
[master (root-commit) b992814] Premier commit
 1 file changed, 5 insertions(+)
 create mode 100644 Menu.txt
 $ git log
 

Utiliser des branches

  1. Créer une branche

$ git checkout -b vegetarien Switched to a new branch 'vegetarien'

  1. Basculer sur une branche existante

$ git checkout master Switched to branch 'master'

  1. Supprimer une branche existante

$ git branch –d japonais

  1. Lister les branches existantes

$ git branch

master

* vegetarien

  1. Merger (i.e. fusionner) une branche dans la branche courante

$ git merge vegetarien

Les tags

 $ git tag michelin17 
 $ git tag
michelin17
 $ git push origin michelin17
Total 0 (delta 0), reused 0 (delta 0)
To https://github.com/ulrich06/TD_Git.git
  - [new tag]         michelin17 -> michelin17
 git push origin --tags 

Ressources

That’s all folks

1)
Un éditeur s'ouvre qui dépend de votre configuration. S'il ne vous convient pas, vous pouvez le configurer par exemple
 git config --global core.editor emacs 
2)
Au lieu d'un git add suivi d'un git commit vous pouvez préférer
 git commit -a -m "ajout des aubergines"
3)
Vous vous demandez quand créer des branches, regardez ici