SCM avec l'application desktop

Travailler depuis le site ahttps://github.com/ uniquement est très limitant. Github est le lieu où est stocké du projet, l'outil qui fait tout fonctionner est git. Avant d'utiliser la ligne de commande qui peut être intimidante, utilisant une application développée par github qui permet d'en utiliser les fonctions les plus courantes.

On va reprendre le projet précédent pour créer son projet chez soit ainsi que l'origin en utilisant l'application desktop. Ceci vous permettra de savoir comment :

• faire un clone
• notion de gestion distribuée
• créer un nouveau projet
• l'index aussi nommé stage
• faire un rebase

Installation

Configuration

Lier le compte github

Lors du premier lancement de l'application vous devriez avoir un fenêtre de ce genre :

Connectez vous à github pour associer votre login à l'application :

Ignorez les fenêtres si vous en avez et arrivez là :

Préférences

Allez dans les préférences (file > options sous windows ; github desktop > préférences sous mac) et vérifiez que :

• "Accounts" : pointe bien vers votre compte github
• "Integration" :
  • external editor : mettez vscode (ou votre éditeur de code préféré)
  • shell : votre terminal préféré
• "Git" : connaisse bien votre vrai nom (pas de pseudo) et une adresse mail où vous joindre.

Dans l'onglet de préférences git cliquez sur "edit your global git config" :

Ceci va vous ouvrir l'éditeur que vous avez choisi dans les préférences integration avec le fichier de configuration global de git. Assurez vous d'avoir la préférence ci-dessous :

[pull]
	rebase = merges

Qui va par défaut faire un rebase plutôt qu'un merge lorsque l'on récupère les modification de l'origine.

[user]
	name = François Brucker
	email = francois.brucker@gmail.com
[core]
	editor = vim
[color]
	ui = true
[pager]
	log = false
[pull]
	rebase = merges
[filter "lfs"]
	process = git-lfs filter-process
	required = true
	clean = git-lfs clean -- %f
	smudge = git-lfs smudge -- %f
[init]
	defaultBranch = main

Projets

Puisque vous travailler sur votre ordinateur, il vous faudra également une application vous permettant de créer et modifier des fichiers texte. Je vous conseille d'utiliser vscode :

Récupérer un projet

Commençons par récupérer le projet précédent et voir comment tout ça se passe dans l'application.

1. choisissez "clone a project from the internet"
2. vous devriez voir vos le projet dans l'onglet "Github.com"
3. en cliquant sur le bouton "clone", votre projet va aller dans un dossier de votre ordinateur

Une fois cliqué sur "clone" on se retrouve devant la fenêtre suivante :

Remarquez qu'en cliquant sur "history", on retrouve tout l'historique du projet :

La solution utilisée par git consiste à ne pas choisir de serveur distant avec des règles précises : tout participant possède l'intégralité de la structure de sauvegarde comme s'il était seul développeur. On ajoute enfin souvent un participant fictif, nommé origin, qui est la référence commune et est synchronisée à l'envie par les développeurs. Cette structure distribuée permet :

• que chaque développeur puisse faire ses propres commits en local,
• d'avoir une (ou plusieurs) branches partagée par tous les utilisateurs (comme main, dev, etc) et synchronisés souvent entre les utilisateur et origin :
  • on appelle push les synchronisation des utilisateurs vers l'origin
  • on appelle pull les synchronisation de l'origin vers un utilisateur
• de continuer un projet avec une nouvelle équipe, il suffit de copier origin.

Chaque membre d'un projet aura chez lui une copie complète du projet, avec tous les commit et toutes les branches.

Pour communiquer les changement effectué chez soit aux autre membre de l'équipe, une technique courante est de désigner un clone particulier qu'on nomme origin — c'est celui sur github — et qui sera le lieu où l'ou enverra nos modifications (push) et où l'on récupérera les dernières avancées des collaborateurs (pull)

Nouveau projet

Créons un nouveau projet jouet :

1. choisissez de créer un nouveau projet dans la fenêtre principale : Je l'ai appelé animaux
2. l'application a cré un dossier animaux sur mon ordinateur :

Tout a été fait sur votre ordinateur. Rien n'a été mis sur github pour l'instant. Faisons le :

Dans la fenêtre cliquez sur publish your repository to github :

Allez sur github pour voir que le projet est présent.

Vous voyez que l'application a mis un fichier (caché) .gitattributes, on ne s'en en occupe pas, c'est une optimisation que desktop fait pour nous.

Liste des fichiers à ignorer

Allez dans les préférences du projet Repository > repository settings puis choisissez l'onglet ignored files :

Ceci vous permet de créer ou de modifier votre liste de fichiers à ignorer. Vous voyez sur la copie d'écran que j'ai ajouté aux fichiers ignorés :

• la poubelle du Macintosh (le dossier .DS_Store par exemple)
• les fichiers relatif à votre éditeur de texte (comme les fichiers .vscode où vscode range ses préférences),
• les fichiers temporaires et de log
• ...

TBD faire un fichier TBD.txt que l'on met en .gitignore TBD ajouter des choses à faire.

Ajoutons des fichiers

Utilisons vscode pour "ouvrir un dossier" puis choisir le dossier contenant notre projet.

Ajoutons y 3 fichiers :

• poissons.txt

  Anchois
  Sardine
  Requin
  

• mammifères.txt

  Chat
  Homme
  Girafe
  

• oiseaux.txt

  Pinson
  Mouette
  Goéland
  

Dans l'application desktop on voit qu'il y a 3 changements par rapport à la position précédente :

Les 3 nouveaux fichiers sont sélectionnés. Le prochain commit prendra en compte ces 3 fichiers.

Faisons un commit. On voit que les 3 fichiers ont été pris en compte dans le commit. Il n'est plus nécessaire de commiter chaque fichier comme on l'avait fait en travaillant directement sur le site de github !

Pousser l'historique sur github

Pour l'instant, nous n'avons travailler que chez nous. Rien n'a été mis sur github. Pour le faire, il suffit de cliquer sur le bouton "push origin" pour le faire.

Faisons le.

Tout s'est bien passé, il n'y a pas eu de conflit. Créons un conflit pour voir comment le résoudre.

Résolution de conflit

On va :

1. modifier sur le site de github un fichier
2. modifier le même fichier chez nous
3. tenter de pousser nos modifications sur le serveur.

situation sur github

On modifie le fichier oiseaux.txt :

Pinson du nord
Mouette
Gabian
Hibou petit duc

Et on commit les changements :

origin : A -> B

Vous pouvez faire toutes les modifications que vous voulez, , du moment qu'on supprime les références aux commits en conflit.

TBD donner des exemple avec le conflit et les modification on fait une union ou même on fait autre chose.

situation à la maison

On modifie le fichier oiseaux.txt pour mettre les oiseaux dans l'ordre alphabétique :

Goéland
Mouette
Pinson

Et on commit les changements :

nous : A -> C

Situation globale

On se retrouve dans la situation suivante, sur la même branche main :

origin : A -> B
          \
nous   :    -> C

Sur l'application desktop, notre bouton de communication avec le serveur dit*"fetch origin"* :

Cliquons sur ce bouton pour nous retrouver dans la situation suivante :

On voit que github et nous différons tous deux d'un commit.

Résolution du problème

Nous pourrions faire comme précédemment et faire un merge des deux histoires. On aurait du coup un historique comme ça :

origin : A -> B --> D
          \     /
nous   :    -> C

Mais notre nouvelle branche n'est pas informative. Elle ne correspond à rien d'un point de vue sémantique. C'est juste une façon de rabouter les deux main ensemble. Pour ce genre de cas (c'est à dire 90% du temps) on préfère une autre solution : le rebase

On va re-écrire notre histoire en fonction de l'origine, c'est à dire transformer ça :

origin : A -> B
          \
nous   :    -> C

en ça :

origin : A -> B
               \
nous   :         -> C'

Il faut transformer notre commit C en le commit C' qui pourra s'intégrer tout seul dans l'histoire de l'origine : cette opération s'appelle un rebase.

C'est exactement ce que va faire desktop lorsque l'on clique sur le bouton pull.

Une fenêtre apparaît pour dire qu'il y a un soucis. Ne prenez pas peur et fermez cette fenêtre. On arrive à cette fenêtre là :

On sait faire. Il suffit d'éditer le ficher dans vscode et de faire comme pour le merge dans le projet précédent. Le nouveau fichier oiseaux.txt devient :

Goéland
Hibou petit duc
Mouette
Pinson du nord

On a régler un problème dans le rebase. COmme c'était le seul, desktop nous permet de continuer :

On clique sur le bouton "continue rebase". Pour arriver à cette situation :

Il n'y a plus de conflit avec l'origin, puisque son commit d'avance a été intégré dans notre historique. Allez dans l'historique pour le voir :

Notre commit a été re-écrit pour tenir compte du commit de l'origin (qui est passé avant le notre) :

On peut maintenant pousser nos changements sur github sans soucis en cliquant sur le bouton "push origin"

Il y a au final tous les commit sur github (victoire !)