Introduction à Git

Gestion de version

Travail en équipe

Dépôt local/distant

Workflow

Conflit

👉 Slides

Author

Ludovic Deneuville

Introduction

Outil indispensable
Utilisation :
- TP informatiques, R
- Dans tous vos projets
- Dans votre vie professionnelle

Utilisé en projet
Évalué en Compléments d’info 2A
Suivi d’un TP

⚠️ valable pour tous les TP :

lisez le sujet avant
soyez prêts (pas 20 min pour se logger)
n’allez pas trop vite
suivez précisément les consignes
réfléchissez (il peut y avoir des coquilles)
< … > -> remplacer

Introduction

Vous faites partie d’une équipe de 5 personnes qui doit coder une application de jeux de cartes.

😕 Comment mettre en commun votre code ?

Vous développez chacun de votre côté et à la fin, vous mettez tout en commun
Vous envoyez vos programmes par mail
Vous créez un dossier commun

😅 En cas d’erreur, comment revenir en arrière ?

On va essayer de trouver un moyen pour bosser efficacement.

Au programme

📌 Versionner son code
💾 Historique des modifications
👷 Travail en équipe

2 grandes problématiques :

Versionner le code
Partager du code

Pourquoi versionner ?

Quelle est la bonne version ?
Comment faire pour revenir en arrière ?
Qui a écrit ce code ? Quand ?

les questions que l’on peut se poser en projet
Mais qui a écrit cette merde ???
- ah ben c’est moi… il y a 2 ans
- plutôt bon signe -> ça veut dire qu’on progresse

Pour connaître la véritable dernière version

Même si vous êtes bien intentionné, ça finira par déraper

Solutions naïves :

Pas de versionnage
- vous écrasez les anciens fichiers
Copier intégralement le dossier à chaque modif
- projet_v1, projet_v2
incrémenter les noms de fichier

├─── Projet info
│   ├─── old
│   │   ├─── Rapport.qmd
│   │   ├─── Rapport_new.qmd
│   │   ├─── Rapport_v1.0.qmd
│   │   ├─── Rapport_v1.0_new_old.qmd
│   │   └─── Rapport_v1.1.qmd
│   ├─── Rapport_old.qmd
│   ├─── Rapport_2022.05.15.qmd
│   └─── Rapport_2022.05.15_latest.qmd

😕 Quelle est la bonne version du fichier ?

😊 Un seul fichier + l’historique des modifications

├───Projet info
│   └───Livrables
│     └───Rapport.qmd

Date         Heure   Auteur      Message commit
----         -----   ------      --------------
2022.05.29   23h58   bianca      "Version finale"
2022.05.29   23h40   archibald   "j'avais oublié l'intro"
2022.05.29   21h32   tryphon     "ajout partie 2"
2022.05.29   20h25   bianca      "v1.1"
2022.05.29   20h12   tryphon     "Création du rapport"

Ancien code commenté

Vous souhaitez passer de R-base à ggplot2 pour votre graphique.

Mais vous vous dites que c’est mieux de garder l’ancien code au cas où…

analyse.R

library(ggplot2)

data <- data.frame(x = seq(-4, 4, length=100))
data$y <- dnorm(data$x)

# plot(data$x, data$y, type="l", lwd=2, col="blue",
#      main="Densité de la loi normale centrée réduite",
#      xlab="x", ylab="Densité")
# abline(h=0, col="gray")

ggplot(data, aes(x = x, y = y)) +
  geom_line(color = "blue", size = 1) +
  ggtitle("Densité de la loi normale centrée réduite") +
  xlab("x") +
  ylab("Densité") +
  theme_minimal()

analyse.R - Commit 05016ab - Date 2024.06.02 - Author tryphon

data$y <- dnorm(data$x)

plot(data$x, data$y, type="l", lwd=2, col="blue",
     main="Densité de la loi normale centrée réduite",
     xlab="x", ylab="Densité")
abline(h=0, col="gray")

analyse.R - Commit f97f766 - Date 2024.06.04 - Author bianca

library(ggplot2)

data <- data.frame(x = seq(-4, 4, length=100))
data$y <- dnorm(data$x)

ggplot(data, aes(x = x, y = y)) +
  geom_line(color = "blue", size = 1) +
  ggtitle("Densité de la loi normale centrée réduite") +
  xlab("x") +
  ylab("Densité") +
  theme_minimal()

La solution

La solution, tous en choeur, c’est …

Git

git : connard en argot britannique

Objectifs :

1A apprentissage
2A fluent
3A maitrise

Historique

Créé par Linus Torvalds en 2005
Pour gérer le développement du noyau Linux
Le standard incontournable de la gestion de versions
Anciens outils : CVS, SVN

Standard : produit qui s’est imposé par l’usage (ex : Moteur de recherche Google, TCP/IP)
- peu causer des problèmes de monopole…

Logiciel

Logiciel Libre, Open source
Gratuit
Décentralisé

Note

😨 Git s’utilise majoritairement en ligne de commande dans un terminal Git Bash.
😅 Pas de panique, quelques commandes suffisent pour travailler avec Git.

Il existe aussi des interfaces graphiques mais elles sont souvent imparfaites et sources d’erreur.

Logiciel libre
- code source est ouvert et disponible
- permettant à quiconque de l’utiliser, le modifier, et le distribuer librement
- différent de gratuit
- légèrement différent de Open source
  - Open Source : avantages pratiques et collaboratifs
  - Libre : libertés et les droits éthiques des utilisateurs
Décentralisé
- chaque utilisateur dispose d’une copie complète de l’historique de tout le projet

Késako

Git ➡️ Logiciel de gestion de versions
Git Bash ➡️ Terminal pour écrire des commandes git
GitHub / GitLab ➡️ Plateforme de développement collaboratif
- Héberge des dépôts Git
- Propose d’autres fonctionnalités (CI/CD, wiki, gestion des incidents…)

GitHub racheté par Microsoft en 2018
GitLab, Libre, possible d’avoir son propre GitLab interne

Git Bash

Terminal de commande
Plusieurs manières de lancer (Menu Windows, clic droit, inclus dans VSCode)

Conseil : lors de l’installation de Git, choisissez le terminal Unix

1ere ligne : prompt (username, machine, répertoire actuel)
2e ligne (commence par $) : commande
3e ligne : résultat de la commande

Bref aparté sur les commandes Unix.

Il fut un temps où tout se faisait par ce biais (pas d’explorer)

Commandes Unix

Commande	Description
`ls` (ou `ll`)	Liste le contenu d’un répertoire
`pwd`	Affiche le répertoire courant
`cd <directory>`	Change le répertoire de travail courant
`mv <src_file> <dest_file>`	Déplace des fichiers ou des répertoires
`cp <src_file> <dest_file>`	Copie un fichier ou un répertoire
`mkdir <directory>`	Crée un nouveau répertoire
`rm <file_or_dir>`	Supprime des fichiers ou des répertoires
`touch <filename>`	Crée un nouveau fichier vide
`cat <filename>`	Affiche le contenu d’un fichier
`grep <text> <filename>`	Rechercher dans un fichier

Commande	Signification
`ls` (ou `ll`)	list
`pwd`	print working directory
`cd <directory>`	change directory
`mv <src_file> <dest_file>`	move
`cp <src_file> <dest_file>`	copy
`mkdir <directory>`	make directory
`rm <file_or_dir>`	remove
`touch <filename>`
`cat <filename>`	concatenate
`grep <text> <filename>`	global regular expression print

ce qui est entre < … > est à remplacer
ll : ls -l
cd : change directory
pwd : print working directory
mkdir : make directory
pour éditer un fichier : vi, nano
man

Attention avec les commandes rm, kill

Commandes Unix - Exemples

Pour chaque commande, de nombreuses options sont disponibles

ls *.py              # liste tous les fichiers python du répertoire courant
ls *.py > a.txt      # crée un fichier a.txt contenant le résultat de la commande
cd ..                # se positionne dans le répertoire parent
cd ../projet/src     # remonter dans le dossier parent puis aller dans projet puis src
cp /p/image.jpg .    # copie le fichier image.jpg du disque P dans le dossier courant
./setup.sh           # lance le programme setup.sh du répertoire courant

Tip

. : représente le dossier courant
.. : représente le dossier parent
~ : répertoire personnel de l’utilisateur (echo $HOME)

répertoire = dossier

La ligne de commande reste très utilisée :

rapide, efficace
automatisation
- exemple : renommer 1000 fichiers d’un dossier

git add .: add current

Copier-Coller

Warning

CTRL + C et CTRL + V ne fonctionnent pas toujours !
CTRL + C : stopper un processus (très utile)

2 possibilités pour coller du texte :

Clic droit
MAJ + INSERT

Raccourcis indispensables:

CTRL+ A : select all
TABULATION: autocomplete
HISTORIQUE ⬆️ et ⬇️

Versionner son code

Au début j’ai parlé de versionner
Comment faire avec Git

Que versionne-t-on ?

✅ des fichiers de type texte (légers)
✅ du code source
❌ fichiers de données
❌ mots de passe
❌ outputs : logs, .pdf, .doc

un dépôt doit rester léger
quelques Mo max
possible de mettre du doc ou pdf
- mais git ne sait comparer que du txt, csv, md
- tout ce qui peut s’ouvrir avec notepad

Workflow

sequenceDiagram
    Workspace ->> Staging index: add
    Staging index ->> Local repository: commit
    Local repository ->> Remote repository: push
    Remote repository ->> Workspace: pull

Retenir Local et Remote, mais en fait c’est un peu plus complexe :

ça fait un peu peur, pas intuitif au début
workspace : tous les fichiers de votre dossier
staging : fichiers reconnus par git
local : sauvegardes du dépôt local

Plus facile dans un sens que l’autre

Créer un commit

2 étapes pour créer une nouvelle version :

git add <filename>
- ajouter le fichier à l’index (i.e. dire à Git de suivre ce fichier)
- git add . : pour ajouter tous les fichiers
git commit -m "<mon message>"

git utilise la sauvegarde incrémentale
il ne garde que les modifs apportées depuis le dernier commit

https://talks.freelancerepublik.com/git-commandes-indispensables-developpeurs/

Exemple

├─── Projet info
│   ├─── src
│   │   ├─── main.py
│   └─── doc
│   │   └─── Rapport.txt

Votre dépôt avant de commencer à coder.

├─── Projet info
│   ├─── src
│   │   ├─── main.py               <- fichier modifié
│   │   ├─── velo.py               <- nouveau fichier
│   └─── doc
│   │   └─── Rapport.txt

Vous avez :

modifié un fichier
créé un nouveau fichier

Vous ajoutez les fichiers créés ou modifiés à l’index :

git add .

Vous créez un point de sauvegarde

git commit -m "feat: ajout de l'utilisation de velo"

vous venez de créer un nouveau commit
il est possible de consulter les commits précédents
- git checkout <commit_number>

git checkout <commit_number> : les fichiers de votre dépôt sont alors dans l’état où ils étaient à ce commit

Message du commit

😔 Ce n’est pas toujours évident de trouver un message court et explicite.

Tip

Utilisez un préfixe à votre message selon le pattern <type>: <sujet>:

doc: mise à jour documentaire
feat: nouvelle fonctionnalité
fix: correction
refactor: mise au propre du code
revert: retour arrière
test: Modification des tests

Suffixe WIP

Mon petit commit

Privilégiez de nombreux petits commits à un gros commit final :

Un commit = une modification cohérente
Plus facile de comprendre l’historique
Plus facile de revenir en arrière

Retour arrière

Si finalement, vous n’avez pas envie de « commiter » vos modifications ?

Commande	Description
`git restore <file>`	Annuler les modifications locales non indexées du fichier
`git reset <file>`	Desindexer un fichier
`git reset --hard`	Revenir à l’état du dernier commit, perdant toutes les modifications locales
`git stash`	Sauvegarder et remettre le working directory à l’état du dernier commit

Caution

Attention avec les commandes contenant les mots force, hard…

Ignorer des fichiers

Le fichier .gitignore

.gitignore est un fichier présent à la racine du dépôt permettant de dire à Git quels fichiers il doit ignorer. Par exemple, s’il contient :

*.csv ➡️ tous les fichiers csv seront ignorés par Git
data/ ➡️ le dossier data et son contenu sera ignoré

Cela est utile, pour exclure par exemple du dépôt Git :

des fichiers contenant des mots de passe, des jetons d’accès…
des fichiers volumineux de données qui n’ont pas vocation à être versionnés
des fichiers de log

En info, il y a souvent plein de fichiers de config
⚠️ Mots de passe ➡️ git garde tout l’historique
Next
- c’était pour la partie “gestion du dépôt local”
- ensuite regardons comment communiquer avec le dépôt distant

Exemple

.gitignore

.env
.venv/
__pycache__/
.pytest_cache/
.ruff_cache/

*.log

doc/exams/**/*2026*

Git / pas Git ?

Un petit quizz !

Projet info

Projet info/
├── .github/
│   └── workflows/
│       └── ci.yml
├── backend/
│   ├── pyproject.toml
│   └── src/
│       ├── dao/
│       ├── service/
│       └── main.py
├── data/
│   ├── create_tables.sql
│   └── insert_data.sql
├── doc/
│   ├── rapport.qmd
│   └── suivi.md
├── .env
├── .gitignore
├── docker-compose.yml
└── README.md

Git mais attention :

dossier data/ -> bof
fichier .env -> mots de passe…

Projet éco

Les Nudges/
├── Articles/
│   ├── Sunstein_2014_Nudging.pdf
│   ├── Kahneman_1990.pdf
│   └── Nudges that dont nudge.pdf
├── Notes/
│   ├── idees.docx
│   ├── bibliographie.docx
│   └── données.csv
└── Rapport/
    ├── rapport.docx
    ├── rapport_v2.docx
    ├── rapport_v3_final.docx
    ├── rapport_v3_final.pdf
    └── rapport_v3_final_corrige.docx
    ├── presentation.pptx
    └── presentation_finale.pptx

Pas Git :

versions gérées manuellement
beaucoup de fichiers Word/PDF

Projet stat

Projet Loto/
├── .gitignore
├── README.md
├── suivi.md
├── data/
│   ├── README.md
│   └── loto.csv
├── R/
│   ├── 01_load.R
│   ├── 02_clean.R
│   ├── 03_explore.R
│   ├── 04_analyze.R
│   └── 05_visualize.R
├── rapport/
│   ├── rapport.qmd
│   └── rapport.pdf
└── presentation/
    └── soutenance.qmd

Git :

fichiers versionnés
Repo bien organisé

Réglement de scolarité

J’ai pris un exemple dans une école au hasard, c’est pas chez nous

Travailler en équipe

Dépôt local et dépôt distant

1 dépôt distant
- appelé aussi remote
- hébergé sur une forge (GitHub, GitLab…)
n dépôts locaux
- clone sur votre machine
- git permet la synchronisation des dépôts

Remarque

Il est tout à fait possible d’avoir plusieurs clones du même dépôt sur son poste.

avoir un accès internet / réseau local pour communiquer avec remote
c’était pas nécessaire pour faire des add / commit

Commencer dessin avec :

un remote v0
2 clones de Bob et Alice en v0

Dépôt local et dépôt distant

Important

Chaque dépôt est une copie intégrale du projet.

flowchart
    github[(Dépôt distant)]
    dev1[(Dépôt local 1)]
    dev2[(Dépôt local 2)]
    
    github <--> dev1
    github <--> dev2

Comme une cellule du corps humain.

Si vous perdez un dépôt, il suffit de repartir d’un autre

Communiquer avec le dépôt distant

git pull : mettre à jour son dépôt local à partir du dépôt distant
git push : envoyer ses commits locaux sur le dépôt distant

Important

Il est important de push et pull régulièrement son code pour garder son dépôt à jour.

Vous faites toujours vos actions sur un dépôt local.

Vous ne modifiez jamais le dépôt distant.

push and pull réguliers sinon vos versions vont diverger

git push

Dépôt local ➡️ Dépôt distant

Pour pouvoir pousser son code, il est nécessaire :

d’avoir au préalable créé au minimum un commit
que votre dépôt local soit à jour
- pas de retard de version par rapport au dépôt distant
- si ce n’est pas le cas, il faut commencer par git pull

Vous pouvez push plusieurs commits

git push - si votre dépôt local n’est pas à jour

! [rejected]        main -> main (fetch first)
error: failed to push some refs
hint: Updates were rejected because the remote contains work that you do not
hint: have locally. This is usually caused by another repository pushing to
hint: the same ref. If you want to integrate the remote changes, use
hint: 'git pull' before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

Le message est assez explicite.

git push - fichier disparu

Vous venez de faire un git push
Mais votre fichier n’apparait pas sur le dépôt distant…
Probablement parce que vous avez oublié de l’ajouter à l’index avec git add <mon_fichier>

Autre possibilité : votre fichier est ignoré par git car il fait partie du .gitignore

ça arrive quand vous voulez aller trop vite

git pull

Dépôt local ⬅️ Dépôt distant

Mise à jour de votre dépôt local
S’il y a eu des modifications sur le dépôt distant

Un pull se fait généralement après un commit.

git pull - conflit

Que se passe-t-il si :

Alice a modifié un fichier et poussé sa modification sur le dépôt distant
Vous avez également modifié le même fichier et vous faites un git pull pour mettre à jour votre dépôt à partir du dépôt distant

😨 Un conflit ! Git ne sait pas choisir quelle est la bonne version entre la vôtre et celle d’Alice.

git pull - conflit

😅 Pas de panique ! Pour résoudre le conflit, il faut simplement :

modifier le fichier en question pour garder la bonne version
git add puis git commit pour valider la résolution du conflit

Il apparaît sur votre dépôt local.

conflit ≠ erreur
ça arrive

2 versions s’opposent

c’est un exemple, il peut y avoir d’autres types
git est assez bon pour merge (même si 2 modifs sur même fichier)
mais en cas de doute, il ne peut pas choisir

velo.py

class Velo:
    def __init__(self, couleur):
        self.couleur = "bleu"

velo.py

class Velo:
    def __init__(self, couleur):
        self.couleur = "blanc"

velo.py

class Velo:
    def __init__(self, couleur):
        self.couleur = "noir"

Résoudre un conflit

Contexte
- Premier arrivé, premier servi
- Le conflit (après votre pull)
Conflit
- Git n’est pas un juge
- VSCode : accept incoming/current/both change
Résolution
- supprimez les <<<<<<< et ======= ➡️ pas du python
- si vous relancez votre programme comme ça, il va pas aimer

Le conflit se résout sur son dépôt local !

Alice a poussé son code avant vous
Vous faites donc un git pull
- En effet, vous devez impérativement mettre à jour votre dépôt local avant de pousser votre code
2 versions s’opposent sur votre dépôt local
- self.couleur = "noir" vs self.couleur = "blanc"
Git n’est pas capable de choisir laquelle est la bonne 🤷‍♀

En haut : votre version
En bas : celle provenant du dépôt distant

class Velo:
<<<<<<< HEAD
    def __init__(self, nom, couleur, vitesse_max):
        self.couleur = "noir"
=======
    def __init__(self, nom, couleur, marque):
        self.couleur = "blanc"
>>>>>>> a57ae9120dbf97dbab78f82db81f5fc8f48f3821

Pour résoudre ce conflit, 3 possibilités :

vous choisissez votre code
vous choisissez celui d’Alice
vous choisissez un mix des 2

Ensuite, vous validez, créez un commit et poussez le code (git add ., puis git commit -m "<message>" et git push).

Etat du dépôt local

Est-ce qu’il y a des fichiers :

non suivis ? Untracked files
prêts à être commités ? Changes to be committed
modifiés non ajoutés à l’index ? Changes not staged for commit

Important

La commande git status permet de répondre à ces questions.

Elle peut être utilisée n’importe quand, sans modération ! 🍻

git status

Est-ce que votre dépôt local est en avance de n commit par rapport au dépôt distant ?

Cloner un dépôt

Pour créer votre dépôt local.

git clone

Allez sur la page du dépôt distant (GitHub, GitLab…)
Cliquez sur le bouton Code
Copiez l’adresse https ou ssh du dépôt distant
git clone <adresse_depot>
exemples :
- git clone https://github.com/ludo2ne/Git-tuto.git (https)
- git clone git@github.com:ludo2ne/Git-tuto.git (ssh)

Créer sans cloner

Remarque

Il est possible de créer un dépôt local sans cloner un dépôt distant (git init).

Et éventuellement ensuite de le brancher à un dépôt distant.

Cependant ce cas d’utilisation est assez marginal.

https ou ssh ?

2 protocoles différents pour communiquer avec le dépôt distant.

À utiliser sur les datalabs.

Plus simple, pas besoin de configuration
Nécessite un token si vous voulez pousser du code

À utiliser si vous travaillez sur la VM ENSAI.

Configuration initiale des clés SSH
Plus pratique pour des interactions fréquentes
Pas de saisie de mot de passe après configuration

ssh :
- clé publique / clé privée -> config machine
- vous générez un secret depuis votre machine
https :
- GitHub génère un token

Commandes principales

Commande	Description
`git clone <adr>`	Créer un dépôt local sur son poste
`git status`	Voir où l’on en est
`git add <file>`	Ajouter pour le prochain commit
`git commit -m "<msg>"`	Créer un point de sauvegarde
`git pull`	dépôt local ⬅️ dépôt distant
`git push`	dépôt local ➡️ dépôt distant

clone : bouton vert code sur GitHub, GitLab

Autres commandes

git diff : différence avec le dernier commit
- git diff <filename>
git checkout <commit_number> : passer à un commit spécifique
git log : historique des commits
- git log --all --decorate --oneline --graph

La routine Git

je commence par git pull pour mettre à jour mon dépôt local
je code
j’ai fini, je teste mon code, ça marche 🎉
git status pour voir l’état du dépôt
git add <filename> pour ajouter mes fichiers au prochain commit
git commit -m "blabla" pour créer un point de sauvegarde
git pull pour voir si personne n’a poussé depuis mon dernier pull
si besoin, je résouds les conflits
je pousse mon code git push

pull : des fois qu’un camarade ait codé la nuit

Démo

aller sur GitHub, cloner
créer un fichier, status
reset, status
modifier un fichier, status
commit
modifier sur github
push

Travailler sur le Datalab

Services non pérennes
Sauvegarder votre code

↪ Indispensable d’utiliser Git !

vous ne travaillerez pas toujours en local
mais parfois sur des services à la demande
ex : besoin de puissance de calcul

Aller plus loin

Les branches
GitFlow
Pull request
Open source

Glossaire

Les bases

Terme	Synonymes	Signification
Git	Outil de versionnage	Logiciel qui gère les versions et l’historique du code
GitHub	Plateforme Git	Service web pour héberger et collaborer sur des dépôts Git
Git Bash	Terminal	Terminal pour lancer des commandes Git
Dépôt	Repository, Repo	Dossier contenant un projet Git (code + historique)
Remote	Dépôt distant	Dépôt hébergé sur un serveur (GitHub, GitLab…)
Local	Dépôt local, Clone	Copie d’un Remote sur ordinateur, ou dans ton service
Commit	Point de sauvegarde	État du projet à un instant donné
Push	Envoyer	Transmettre les commits locaux vers le dépôt remote
Pull	Récupérer	Ramener les commits du remote vers le local et les fusionner

Autres

Terme	Synonymes	Signification
Branche	Branch	Ligne parallèle de développement dans un dépôt
Main	Master	Branche principale (tronc)
Merge	Fusion	Action de combiner une branche dans une autre
Fork	Copier un remote	Copier un remote sur son propre compte GitHub
Issue	Ticket	Outil pour signaler un bug, une tâche ou une discussion
Pull Request	PR, Merge Request	Proposition d’intégrer des changements d’une branche vers une autre

Bibliographie

Git : un élément essentiel au quotidien, Python pour la datascience, Lino Galiana
Formation Git du Lab INSEE
Formation Git du SSM Agriculture
GitFlow
Développement basé sur le tronc