index

{saperlipopette}, un paquet R

pour progresser en Git

en toute sérénité

Maëlle Salmon (rOpenSci, cynkra)

https://rr2024-maelle.netlify.app/

Git, outil de contrôle de version

De script-vraiment-final-2024-05-27.R à un vrai historique.

Pas du R mais très utile, voire indispensable, pour écrire du code.

Sans Git

Jour 1 : script.R

Jour 2 : crée le modèle statistique, script2.R

…

Jour 42 : rajoute les graphiques, script-final-2024-06-03.R (40ème copie du fichier 🤪)

Avec Git : ce qu’on fait

différentes versions d'un fichier avec des flèches 'git commit' entre chaque

Avec Git : ce qu’on a

script.R et à côté le dossier .git avec les instantanés

Sans Git

Je veux essayer ggplot2.

Avec Git

Git, c’est pratique

Moins de perte de travail ;
Historique à consulter ;
Essais dans des branches.

Git, la base

Créer des instantanés avec git commit.
Travailler sur une plateforme comme GitHub.
Créer des branches pour expérimenter.

Git, la base

Git, idéal du commit petit et informatif

Mais pourquoi ?!

Une ligne mystérieuse

a script with a mysterious line 'x <- x - 1'

Git blame (explain)

simplified diagram of Git blame: for each line in a script on the left we see who added it, when, with what commit message.

Git blame: cliquer sur l’instantané…

“Sauve un tas de fichiers avant le dej 🍝”

145 fichiers modifiés avec 2 624 additions et 2 209 suppressions.

Git blame: cliquer sur l’instantané…

“fix: adapter le code à l’indexation à partir de 0”

2 fichiers modifiés avec 3 additions et 2 suppressions.

Une mauvaise idée

Oh non, cette idée d’il y a 7 instantanés est mauvaise. Est-ce que…

j’enlève les changements à la main ;
j’utilise Git revert sur l’instantané pas terrible ?

Git revert

Ne marche que si les instantanés sont petits.

Vous faisant un truc avec votre code il y a trois jours

a bunch of scripts, on them an emoji of a happy face wearing sunglasses

Vous faisant ce truc avec votre code aujourd’hui

a bunch of scripts, on them an emoji of a face sobbing

Git bisect: historique Git

a series of emoji, the first one a cool face, then sleeping faces, then a sobbing face

Git bisect: exploration optimale des instantanés

a series of emoji, the first one a cool face, then sleeping faces, then a sobbing face. arrow above a sleeping face.

Git bisect: exploration optimale des instantanés

all faces until the arrow are now cool faces.

Git bisect: exploration optimale des instantanés

Git bisect: exploration optimale des instantanés

all faces after the arrow are now sobbing

Git bisect: exploration optimale des instantanés

Git bisect: exploration optimale des instantanés

Résultat de Git bisect : un instantané !

“Sauve un tas de fichiers avant le sport 💪”

145 fichiers modifiés avec 2 624 additions et 2 209 suppressions.

Résultat de Git bisect : un instantané !

“refactor: commence à utiliser du YAML”

2 fichiers modifiés avec 3 additions et 2 suppressions.

Git, ce qu’il faut savoir

Git est utile dès le début mais encore mieux…

Bien créer son historique ;
Bien l’utiliser.

Mon déclic

Lecture de “Git in practice” de Mike McQuaid

Comment partager ma joie de mieux connaître Git ?

Une idée a germé…

“Oh shit Git” de Katie Sylor-Miller : documentation de solutions simples à de vrais soucis.
reprex : une manière de reproduire une situation.

Créer des exercices Git reproductibles facilement !

{saperlipopette}

Un nom inspiré de “Oh shit, Git”, en plus mignon 😉
12 exercices Git inspirés de “Oh shit, Git” et de mon expérience personnelle. ✨
Pas pour les grand·e·s débutant·e·s.

Changer le message du dernier instantané

saperlipopette::exo_latest_message()

library("saperlipopette")
parent_path <- "../testdir" # withr::local_tempdir()
path <- exo_latest_message(parent_path)

Changer le message du dernier instantané

En ouvrant R, dans path

✖ "Oh shit, I need to change the message on my last commit!
✖ I made a typo!
ℹ See <https://ohshitgit.com/#change-last-commit-message>
ℹ For more help use tip()

Changer le message du dernier instantané

saperlipopette::exo_latest_message()

log <- gert::git_log(repo = path)
log

# A tibble: 2 × 6
  commit                          author time                files merge message
* <chr>                           <chr>  <dttm>              <int> <lgl> <chr>  
1 d3d35a17a880eee777868a5fbe99ce… Jane … 2023-12-15 16:25:00     1 FALSE "add a…
2 e227ecc55e421f70b6e30602e6a2ee… Jane … 2023-12-15 16:25:00     2 FALSE "First…

log$message

[1] "add a new documennnt\n" "First commit\n"

Changer le message du dernier instantané

tip(), dans path

• Examine Git history.
• Notice 'documennnt' should be 'document'! A typo!
• `git commit --amend`
• Examine Git history.

Changer le message du dernier instantané

Résolution avec les outils de notre choix (Git en ligne de commande, clic-bouton dans RStudio IDE, etc.)

Travail futur : proposer une correction.

Exercices de saperlipopette : Apprendre à faire un meilleur historique

mettre un changement sur la bonne branche (git cherry-pick + git reset),
réécrire l’historique d’une branche (git rebase -i),
séparer un tas de changements en plusieurs instantanés (git add --patch),
…

Exercices de saperlipopette : Apprendre à utiliser l’historique

Enlever les fichiers et dossiers non suivis (git clean),
Chercher l’instantané qui a introduit un bug (git bisect),
Enlever un certain changement (git revert).

Pourquoi c’est bien 😁

Des exercices réalistes avec nos outils habituels …
Dans un dossier temporaire où on ne peut rien casser d’important !
Avec des conseils en plus accessibles via tip()

Quelles conditions d’utilisation

S’entraîner tout·e seul·e ;
Faire une démo à des apprenant·e·s avant qu’il·elle·s ne refassent l’exercice sur leurs machines.

Comment ça marche ?

Création de fichiers et d’historique Git. {fs}, {gert}
Copie d’un fichier en tant que .Rprofile, listé dans .gitignore. Ce fichier a les messages d’entrée et la fonction tip() !

Saperlipopette, entraînez-vous à Git !

https://rr2024-maelle.netlify.app/

https://maelle.github.io/saperlipopette