README.md

LÀ GÎT LE GRAAL

L'introduction à GIT dont vous êtes le héros

Aurélien Bénel, 2018 (révisions en 2020, 2022, 2023, 2024)

Prologue

Jeune damoiselle, jeune damoiseau, si vous lisez ce texte c'est que vous avez été jugé•e digne par le Roi Arthur de devenir chevalier de la Table Ronde.

Une fois adoubé•e, vous devez chercher, autour de la Table Ronde, une chaise restée libre et graver votre nom.

👩🏾‍💻

Dans le terminal, indiquez votre nom complet et votre adresse électronique :

git config --global user.email "you@example.com"

git config --global user.name "Your Name"

À cette table, chacun•e peut prendre la parole mais dans le respect de celle des autres. Vous aurez votre propre version de la quête.

👩🏾‍💻

Dans GitHub :

• faites vous une copie publique de l'entrepôt (Fork),
• copiez dans le presse-papier, l'URI de votre entrepôt (code > clone).

Avant de partir à l'aventure, vous harnachez votre cheval et rassemblez votre équipement.

👩🏾‍💻

Doivent être installés sur votre ordinateur : git, une version récente de Node et un éditeur de texte avec prise en charge des formats YAML et Markdown.

Aux portes de Camelot

Vous enfourchez votre fier destrier, sortez des écuries au pas et traversez ce que l'on appelle "la basse cour". À l'instant où vous vous apprêtez à franchir le pont-levis, un vieillard, vêtu d'un long manteau blanc, vous tend une branche de bois.

👩🏾‍💻

1. Dans votre terminal, lancez npx ungit.
2. Dans l'interface qui apparaît, collez l'URI de tout à l'heure dans clone from et lancez la copie privée de l'entrepôt.

L'équivalent en ligne de commande aurait été git clone.

Votre regard se pose sur la baguette : elle est noueuse mais encore verte... Puis votre regard se lève, interrogatif, à la recherche des yeux du vieillard. Mais ce dernier a disparu.

Que de choses se sont passées !

👩🏾‍💻

Éditez le fichier `etat.yml` :

• changez le lieu en pont-levis,
• ajoutez baguette à votre inventaire.

Pour garder le souvenir du déroulement de cette aventure, vous faites une marque sur la baguette avec la pointe de votre couteau.

👩🏾‍💻

Dans ungit, saisissez le titre de votre nouvelle entrée et validez sa création (commit).

L'équivalent en ligne de commande aurait été git commit -a.

Non, sérieusement ?!? Vous croyez qu'on parlera encore de vous dans 15 siècles si vous vous y prenez comme ça ? Sachez qu'il n'y a de bon héros sans un bon ménestrel pour chanter ses exploits. Et que pourra faire un ménestrel de votre histoire si vous ne vous appliquez pas un peu ?

👩🏾‍💻

Dans ungit, amendez (amend) la dernière entrée de manière à ce que le titre :

• commence par un préfixe correspondant au bénéfice de votre exploit (ADVERSAIRE:, ÉQUIPEMENT:, TÉMOIGNAGE:, etc.),
• soit correct grammaticalement,
• soit aussi explicite que possible (tout en restant court).

L'équivalent en ligne de commande aurait été git commit --amend.

Vous constatez avec stupeur que la baguette est désormais un peu plus grande, comme pour recueillir, étape après étape, le récit de vos exploits.

Le chevalier noir

Sur la route, les champs laissent la place aux arbres, les villages aux forêts. Votre monture continue d'un pas régulier, vous vous assoupissez.

Vous êtes réveillé brusquement par une grande douleur au flanc, une sensation de chute et le bruit de votre armure sur le sol. Au-dessus de vous un chevalier en armure noire, vous regarde en ricanant. Le chevalier attache la bride de votre cheval à sa selle et poursuit sa route, vous laissant, couvert de boue (et de honte), dans l'ornière.

👩🏾‍💻

Éditez le fichier etat.yml :

• changez le lieu en route,
• supprimez cheval de votre inventaire,
• retranchez un point à votre santé.

Vous continuez en boitant sur la route... en maudissant le chevalier noir et vous-même. Si seulement, vous ne vous étiez pas endormi ! À vrai dire, peut-être que la magie de la baguette pourrait faire que tout ceci ne soit jamais arrivé...

Allez-y, n'ayez pas peur... Qu'est-ce qui pourrait bien arriver de mal en retournant dans le passé ?

👩🏾‍💻

Dans votre historique, annulez toutes les modifications du dossier depuis la dernière entrée de l'historique (Discard all).

L'équivalent en ligne de commande aurait été git reset --hard.

Et voilà ! À nouveau, vous trottez fièrement sur les routes de Bretagne. La route se sépare en deux :

• à gauche, une borne milliaire romaine indique "Fontaine merveilleuse" (vous avez bien fait d'apprendre le latin !),
• à droite "Roi pêcheur" est gravé sur une pancarte en bois.

Plus attirés par les "merveilles" que par la "pêche", vous et votre cheval vous engagez sur la route de gauche.

La fontaine merveilleuse

Un bruissement cristallin vous guide vers une petite clairière. De l'eau coule de la roche dans une petite cavité avant de disparaître à travers la forêt. Vous vous désaltérez ainsi que votre cheval et une petite quantité d'eau se répand sur la margelle. À ce moment précis, d'épais nuages viennent obscurcir le ciel et une terrible averse se met à tomber.

Vous tentez de vous mettre à couvert, et là, à l'orée de la forêt, vous reconnaissez la sinistre silhouette du chevalier noir. Cette fois-ci, il ne vous aura pas par surprise ! Vous dégainez votre arme et chargez votre ennemi avec un cri guerrier.

Votre charge lui inflige une sérieuse blessure, mais il contre-attaque profitant de l'ouverture.

👩🏾‍💻

Prenez note de cette première attaque dans etat.yml :

• indiquez fontaine comme lieu,
• retranchez 6 points de santé au chevalier noir,
• 3 à vous-même.

Ajoutez une entrée à votre historique.

Faisant de grands moulinets avec son épée, démesurément longue, il parvient à vous faire une grande estafilade au visage.

👩🏾‍💻

Prenez note de son attaque :

• retranchez 2 points à votre santé,
• ajoutez une entrée à votre historique.

Avec le courage du désespoir vous bondissez vers lui et profitant de la lourdeur de son épée, vous tournez autour de lui, enfoncez votre épée entre deux plaques de son armure, d'un côté puis de l'autre. Il tombe à terre. Alors que vous ramassez sa très longue épée, dans un dernier sursaut, il vous étrangle de ses mains.

👩🏾‍💻

Prenez note de cette dernière attaque :

• retranchez tous les points de santé du chevalier noir,
• retranchez en 4 à vous-même,
• ajoutez l'épée longue à votre inventaire,
• ajoutez une entrée à votre historique.

Vous avez gagné mais à quel prix ! Toujours soucieux de l'image que l'on aura de vous dans quinze siècles, vous décidez de résumer un peu (sans rien changer à ce qui s'est passé).

👩🏾‍💻

Dans l'historique, sélectionnez la branche principale, puis squash en face de l'entrée du premier round du combat.

L'équivalent en ligne de commande aurait été git reset HEAD~2 --soft && git commit --amend.

Amendez l'entrée pour que son titre reflète l'ensemble du combat.

Avec votre nouvelle épée à la main, vous êtes fier comme Artaban. Tout irait pour le mieux, si vous ne gisiez pas dans votre sang. Et d'ailleurs, aviez-vous réellement besoin de cette épée ?

Vous décidez d'explorer une autre réalité dans laquelle vous auriez choisi de suivre la route du Roi Pêcheur, où vous n'auriez pas votre épée et ne seriez pas en train d'agoniser...

👩🏾‍💻

Dans l'historique :

• à partir de l'avant dernière entrée, initiez une branche (nommée par exemple fisher-king),
• choisissez de vous placer dans cette nouvelle branche (checkout).

L'équivalent en ligne de commande aurait été git checkout -b fisher-king HEAD~1.

Tout est redevenu comme avant le combat. Seule votre baguette magique garde la mémoire de ce qui s'est passé. Un bourgeon s'apprête à pousser juste au niveau du premier nœud de votre histoire.

Le lion et le serpent

Sur le chemin du Roi Pêcheur, vous découvrez un curieux spectacle : un féroce combat entre un lion et un serpent. Ce serpent n'est pas ordinaire, il crache du feu ! Vous songez un instant à les éviter et à continuer votre chemin. Puis, vous disant en vous-même qu'il s'agit sans doute d'une nouvelle quête permettant de prouver votre valeur et votre bravoure, vous choisissez le parti du lion et attaquez avec lui le serpent.

Le combat est rude, mais à la fin, le serpent s'effondre sur le sol, inanimé. L'espace d'un instant, vous êtes inquiet de l'intérêt que le lion vous manifeste. Mais vous découvrez qu'il lèche vos blessures.

👩🏾‍💻

Prenez note de ce qui vous arrive :

• retranchez 20 points au serpent,
• 8 au lion,
• 2 à vous,
• ajoutez lion à votre inventaire,
• indiquez que vous êtes sur le chemin,
• ajoutez une nouvelle entrée à votre historique.

Harpin de la montagne

Vous traversez un village. Vous faites forte impression avec votre armure, votre cheval et votre nouvel animal de compagnie.

Reconnaissant l'écu de la Table Ronde, des villageois s'adressent à vous : "Oh, noble chevalier, aidez nous, par pitié !". Vous vous approchez et écoutez leur récit : "Harpin, le géant de la montagne, vole notre bétail, détruit nos maisons. Jour après jour, croissent son arrogance, le nombre de ses crimes et notre malheur".

N'écoutant que votre courage, vous faites un détour par la montagne. Le terrible Harpin, sûr de sa supériorité, ne porte pas d'armure. Il ne faut que peu de temps avant qu'il ne soit occis par les crocs de votre lion et le tranchant de votre lame.

👩🏾‍💻

Prenez note de ce qui vous arrive :

• indiquez que vous êtes sur la montagne,
• retranchez 25 points de santé au géant,
• retranchez 1 point à votre lion,
• retranchez 1 point à vous-même,
• ajoutez une nouvelle entrée à votre historique.

Le pont de l'épée

Redescendant de la montagne, vous voyez devant vous le château du Roi Pêcheur. Vous aimeriez y pénétrer. Hélas, un torrent impétueux aux eaux noires comme la mort, vous barre le passage.

Les rives ne sont pas très éloignées. Si seulement vous aviez un objet assez long et assez solide pour vous servir de pont...

Un souvenir un peu flou vous parvient... Comme si dans une autre réalité, vous aviez remporté au prix d'un fier combat, une épée formidablement longue et solide...

Faites se rejoindre les deux réalités.

👩🏾‍💻

Dans l'historique :

• cliquez sur la branche master puis sur checkout.
• cliquez sur la branche fisher-king puis sur merge.

L'équivalent en ligne de commande aurait été git checkout master && git merge fisher-king.

Un halo rouge vous alerte sur le paradoxe temporel qui est en cours :

• vous ne pouvez pas être à la fois mourant et plein de vie (Schrödinger et son chat n'existent pas encore),
• vous ne pouvez pas être à la fois ici et là-bas.

Entre les deux états de santé, choisissez le meilleur (vous n'avez pas vraiment envie, jusqu'à la fin de l'histoire, de ramper en vous vidant de votre sang), par ailleurs, dites que vous êtes sur le pont de l'épée, et combinez vos deux inventaires.

👩🏾‍💻

Une fois que le contenu de etat.yml a été modifié pour garder "le meilleur des deux mondes" (et que les chevrons qui marquent les conflits ont été supprimés), indiquez que les conflits sont résolus (Conflicts > Mark as resolved) et achevez la fusion (Continue merge).

L'équivalent en ligne de commande aurait été git add et git commit.

Votre baguette magique a désormais une forme des plus curieuses : la petite branche rejoint la branche principale.

Traversez le pont de l'épée et pénétrez dans le château.

Le roi pêcheur

Vous êtes accueilli avec beaucoup de bienveillance par le Roi Pêcheur. Celui-ci est couché et blessé à la jambe. Une lance ensanglantée est posée à ses côtés.

Un étrange rituel est à l'œuvre : des serviteurs ouvrent la marche avec des chandeliers, d'autres suivent avec des plats de grand prix, et enfin, au dernier rang, une jeune servante porte un "graal" étincelant. Une lumière presque irréelle semble émaner de l'objet.

Vous vous demandez si le rituel est en lien avec la blessure du roi, si le Graal aurait le pouvoir de guérir sa blessure et sa malédiction. Mais vous n'osez pas poser la question.

La lumière baisse et vos paupières se ferment. Vous vous endormez.

Au petit matin, vous vous réveillez dans la forêt. Le château, le Roi Pêcheur, sa cour, le Graal ont disparu.

Il est temps que vous preniez note de ce qui vous est arrivé. Le Graal, personne ne l'a jamais vu, ni ne sait ce que c'est : une coupe, une fiole de sang, des rouleaux de parchemin, un antique chaudron celte... Qui le sait, si ce n'est vous ?

👩🏾‍💻

• Dessinez ce que vous avez vu et prenez le dessin en photo.
• Déposez le fichier dans ce dossier.
• Éditez ce texte, et mettez le nom de votre image dans la référence ci-dessus de sorte qu'elle s'affiche avec le Markdown preview de votre éditeur de texte. Dans l'historique, vérifiez que les deux fichiers sont pris en compte (celui qui a été modifié et celui qui est nouveau) et créez une nouvelle entrée.

En ligne de commande, vous auriez eu à utiliser git add pour prendre en compte le nouveau fichier, avant de lancer git commit -a.

Vous êtes satisfait de la légende qui raconte vos hauts faits ? Publiez la.

👩🏾‍💻

Dans GitHub, générez un jeton personnel (Settings > Generate new token > public_repo > Generate token) et copiez le dans le presse-papier.

Dans l'historique, sélectionnez la branche principale et publiez la dans votre entrepôt (push). À la place de votre mot de passe, collez le jeton.

L'équivalent en ligne de commande aurait été git push.

Demandez leur avis à vos frères et sœurs d'arme et en retour donnez votre avis sur leur propre légende.

👩🏾‍💻

Dans votre entrepôt sur GitHub, à partir de la liste des branches, faites une demande d'intégration (New pull request) vers l'entrepôt de référence. Commentez les autres demandes d'intégration.

---

Sources

L'analogie entre Git et un jeu vidéo est reprise de l'incontournable Git Magic, celle entre Git et une aventure textuelle de la prometteuse mais inachevée Git-Adventure.

Les scènes de ce tutoriel sont librement inspirées des romans arthuriens de Chrétien de Troyes (XIIe s.) : Yvain ou le chevalier au lion, Lancelot ou le chevalier de la charrette, Perceval ou le conte du Graal.

Certaines images référencées peuvent être protégées par le droit d'auteur.