Car oui, j’ai quand même un fond sérieux, même si le reste du tuto ne m’aide pas à confirmer ces dires. Tout d’abord, si tu veux la version PDF du bouzin, c’est par là: <ahref="https://phundrak.fr/git/tutoriel-git.pdf">https://phundrak.fr/git/tutoriel-git.pdf</a>. Et si tu lis déjà le PDF, la version web est par là: <ahref="https://phundrak.fr/git">https://phundrak.fr/git</a>. Et pour le code source de cette page, c’est sur GitHub (<ahref="https://github.com/Phundrak/tutoriel-git">https://github.com/Phundrak/tutoriel-git</a>) et mon Gitlab perso (<ahref="https://labs.phundrak.fr/phundrak/tutoriel-git">https://labs.phundrak.fr/phundrak/tutoriel-git</a>).
</p>
<p>
Bon, c’était court. Prêt pour le tuto? C’est parti!
Git est un logiciel de version de fichiers permettant de garder une trace de toutes les modifications apportées au fichiers suivis dans un répertoire (un dépôt) et ses sous-répertoires –sous couvert qu’ils n’aient pas été ignorés explicitement. Il permet également de conserver plusieurs versions parallèles du projet, comme par exemple une version stable et une version de développement, et permet l’ajout de modifications d’une de ces versions parallèles à une autre via des fusions partielles ou totales de branches, avec une automatisation des fusions de fichiers lorsqu’il n’y a pas de conflit entre ces derniers.
Très bonne question Kévin. Tout d’abord, il faut t’assurer que git soit installé sur ton système et utilisable depuis le terminal. Sous GNU/Linux, tu peux l’installer via ton gestionnaire de paquet, ce qui rendra la commande accessible directement depuis le terminal.
Si tu n’es pas sous GNU/Linux mais que tu as au moins le goût d’être sous un OS de type Unix, tu peux exécuter la commande correspondante à ton OS suivant:
$ port install git +svn +doc +bash_completion +gitweb # macOS avec MacPorts
</pre>
</div>
<p>
Si tu es sous Windows… Bonne chance. Toutes les commandes seront en syntaxe Unix dans ce tutoriel, mais si tu as bien deux neurones, tu devrais pouvoir tout de même suivre le tutoriel.
Tu peux configurer Git si tu le souhaites, oui. En général, il est recommandé de paramétrer au moins son nom et son email. Tu peux les paramétrer via la ligne de commande:
Tu peux aussi éditer le fichier <code>~/.gitconfig</code> comme suit:
</p>
<divclass="org-src-container">
<preclass="src src-text">[user]
email = ton@email.truc
name = Ton nom
</pre>
</div>
<p>
Cela permettra d’associer ton nom et ton adresse mail à tes commits. Par défaut, ceux qui sont enregistrés avec ton compte utilisateur de ton PC sont mis par défaut dans ces paramètres, mais on met quasiment tous un nom à la con quand on le créé. Et ça permet d’avoir les même paramètres si tu es sur un autre ordinateur.
</p>
<p>
Il y a encore pas mal de paramètres que tu peux gérer avec ce fichier, je reparlerai de certains plus tard, mais pour le reste, la documentation en ligne sur <code>gitconfig</code> ne manque pas.
Si tu souhaites créer un dépôt git, rien de plus simple: créé ton répertoire dans lequel tu travailleras, et déplace-y-toi. Ensuite, tu pourra initialiser ton dépôt via la commande <code>git init</code>.
Si tu obtiens à peu près le même message après la dernière commande, félicitations! Tu viens de créer ton premier dépôt git. En l’occurrence, j’ai créé mon dépôt dans <code>/tmp</code>, mais toi tu peux voir un truc du genre <code>/home/corentin/monsuperprojet</code> à la place. Tu peux vérifier que tout va bien en rentrant la commande <code>git status</code>
Maintenant tu peux commencer à travailler sur ton projet. Mais tout d’abord, on va voir ce qu’il se passe si jamais on créé un fichier dans le dépôt. Créé un fichier <code>main.c</code> dans lequel tu vas entrer ce code:
En exécutant à nouveau <code>git status</code>, on peut voir la sortie suivante:
</p>
<divclass="org-src-container">
<preclass="src src-text">$ git status
On branch master
No commits yet
Untracked files:
(use "git add <file>..." to include in what will be committed)
main.c
nothing added to commit but untracked files present (use "git add" to track)
</pre>
</div>
<p>
Tu commences à comprendre un peu le bail? Git vient de détecter qu’un nouveau fichier a été créé qu’il ne connaissait pas avant. Suivons ses bon conseils et ajoutons le fichier au dépôt.
</p>
<divclass="org-src-container">
<preclass="src src-text">$ git add main.c
$ git status
On branch master
No commits yet
Changes to be committed:
(use "git rm --cached <file>..." to unstage)
Super, maintenant git va surveiller les changements du fichier, mais attention, il n’a pas encore enregistré son état. Pour l’instant il sait juste que le fichier est là, dans un certain état, mais rien ne garanti encore qu’on pourra retrouver cet état plus tard. On appelle ça le <i>staging</i>. Pour ce faire, il faut créer ce qu’on appelle un commit. En gros, il s’agit d’un enregistrement des modifications apportées à un ou plusieurs fichiers (dans leur globalité ou partiellement, on verra ça plus tard), le tout avec un commentaire.
<preclass="src src-text">$ git commit -m "Un petit pas pour moi, un grand pas pour mon projet"
[master (root-commit) 89139ef] Un petit pas pour moi, un grand pas pour mon projet
1 file changed, 6 insertions(+)
create mode 100644 main.c
</pre>
</div>
<p>
Parfait! Certains éléments peuvent être un peu différent chez toi, comme par exemple la référence du commit juste avant le message. Ça, c’est un truc qui est géré automatiquement par git. Et voilà, on a l’état de notre répertoire qui est enregistré et qui sera disponible plus tard. Maintenant, tu sais comment enregistrer des état de ton dépôt via les commits.
Si jamais tu as un staging que tu veux annuler, tu peux utiliser la commande <code>git reset HEAD nomdufichier</code> (ou plusieurs noms de fichiers) pour annuler le staging. Une fois le fichier qui n’est plus dans ton staging, tu peux même annuler toutes les modifications que tu as apporté au fichier depuis ton dernier commit avec la commande <code>git checkout -- nomdufichier</code>, et tu peux aussi mettre plusieurs noms de fichiers. Par exemple, si j’ai modifié mon <code>main.c</code> en modifiant ainsi les arguments du <code>main()</code> :
Si jamais tu veux à la place ajouter la modification d’un fichier au dernier commit (mettons, tu as oublié d’ajouter également un fichier texte), tu peux utiliser l’option <code>--amend</code> lors du commit du fichier oublié.
</p>
<divclass="org-src-container">
<preclass="src src-text">$ git add main.c # J’ai refait les modifications annulées plus tôt
$ git commit -m "second commit"
[master 97f698a] second commit
1 file changed, 1 insertion(+), 1 deletion(-)
$ echo "C’est un super projet !" > projet.txt
$ git add projet.txt
$ git commit --amend -m "second commit + oubli"
[master 9aff4c0] second commit + oubli
Date: Fri Oct 5 11:10:56 2018 +0200
2 files changed, 2 insertions(+), 1 deletion(-)
create mode 100644 projet.txt
</pre>
</div>
<p>
En gros, le commit que tu viens de faire a remplacé le précédent en conservant les informations du commit précédent, mis à part son commentaire. Si tu ne met pas l’option <code>-m "ton texte"</code> lors de l’amendement du commit, ton éditeur texte par défaut va s’ouvrir pour que tu puisses modifier le texte du commit précédent si tu le souhaite. Si jamais vi ou vim s’ouvre et que tu n’as aucune idée de comment sortir de cet enfant du démon, tu as juste à appuyer sur la touche Échap (au cas où), puis à taper <code>:wq</code> (<code>w</code> pour écrire le fichier, <code>q</code> pour quitter), puis tu appuye sur la touche Entrée. Si tu as Nano qui s’est ouvert, alors il faut taper Ctrl-X.
Pas de panique! Tu peux entrer la commande <code>git diff</code> afin de voir ce que tout ce que tu as modifié lors de ton dernier commit. Et si tu ne souhaite voir les modifications que d’un certain fichier, tu peux ajouter le nom de ton fichier à la fin de la commande.
</p>
<divclass="org-src-container">
<preclass="src src-text">$ echo "C’est un super projet !" > projet.txt
$ git diff
diff --git a/projet.txt b/projet.txt
index 03b0f20..b93413f 100644
--- a/projet.txt
+++ b/projet.txt
@@ -1 +1 @@
-projet
+C’est un super projet !
</pre>
</div>
<p>
Tu peux également voir les différences de fichiers entre deux commits en entrant leur référence. Pour avoir la référence, tu peux rentrer la commande <code>git log</code> pour avoir un petit historique des commits.
Un petit pas pour moi, un grand pas pour mon projet
</pre>
</div>
<p>
Bon, c’est un peu long et un peu trop d’infos d’un coup, généralement je préfère taper <code>git log --oneline --graph --decorate</code> afin d’avoir un affichage comme suit:
Dans ce cas, il est grand temps de te présenter le fichier <code>.gitignore</code>. Comme son nom l’indique, il permet au dépôt d’ignorer des fichiers selon ce que tu lui indiqueras. Par exemple, si tu veux ignorer tous les fichiers qui se terminent en <code>.out</code> (ou <code>.exe</code> sous Windows), tu peux éditer (ou créer) ton <code>.gitignore</code> et entrer ces lignes:
</p>
<divclass="org-src-container">
<preclass="src src-text">*.out
*.exe
</pre>
</div>
<p>
Maintenant, si tu créés un fichier en <code>.out</code> ou <code>.exe</code>, il sera complètement ignoré par git et ne sera pas stocké dans l’historique des versions.
Pas de panique! Git dispose d’une fonctionnalité de brachange permettant d’avoir plusieurs versions coexistantes d’un même fichier. Cela peut être très utile pour avoir soit plusieurs personnes travaillant sur un même projet, soit pour une même personne travaillant sur plusieurs fonctionnalités différentes, soit les deux. Ainsi, on a plusieurs version idépendantes que l’on pourra fusionner plus tard.
</p>
<p>
Par défaut une brache est créée lors de la création d’un dépôt qui s’appelle <code>master</code>. Pour créer une nouvelle branche, on peut donc utiliser la commande <code>git checkout -b nomdelanouvellebranche</code>.
À partir d’ici, toute modification apportée aux fichiers du dépôt n’affecteront que la brache courante, <code>nouvelle-branche</code> donc, et les fichiers de la brache <code>master</code> resteront inchangés. Si jamais tu veux retourner pour une quelconque raison sur la branche <code>master</code>, il te suffira d’utiliser la commande <code>git checkout master</code>.
Si tu souhaites avoir une liste des braches du dépôt, tu peux taper <code>git branch --list</code>. La branche active sera marquée d’une étoile à côté de son nom.
</p>
<divclass="org-src-container">
<preclass="src src-text">$ git branch --list
master
* nouvelle-branche
</pre>
</div>
<p>
Au bout d’un moment, tu vas sans doute vouloir fusionner deux braches, par exemple tu as finis de développer une nouvelle fonctionnalité sur la branche <code>nouvelle-branche</code> et tu souhaites l’ajouter à la version stable de ton code qui se situe sur <code>master</code>. Dans ce cas, ce que tu peux faire, c’est retourner sur ta branche <code>master</code>, puis tu vas effectuer ce qu’on appelle un <i>merge</i> ; en gros, pour faire simple, tu vas appliquer les modifications de la branche que tu souhaites fusionner avec ta branche <code>master</code> sur cette dernière.
</p>
<divclass="org-src-container">
<preclass="src src-text">$ git checkout master
Switched to branch 'master'
$ git merge nouvelle-branche
Updating 133c5b6..2668937
Fast-forward
projet.txt | 1 +
1 file changed, 1 insertion(+)
create mode 100644 projet.txt
</pre>
</div>
<p>
Rappelle-toi que la commande <code>merge</code> ramène les commits de la branche spécifiée vers ta branche active, et pas forcément vers le <code>master</code>. Du coup, si tu est sur une brache <code>gisianne</code> et que tu effectues un <code>git merge roger</code>, tu vas rammener tous les commits de <code>roger</code> vers la branche <code>gisianne</code>. Ce peut être intéressant à faire si jamais un bug a été corrigé dans une autre branche ou qu’une fonctionnalité a été ajoutée et que tu veux en bénéficier dans ta branche active. N’oublie juste pas de tout bien commit avant de faire ton <i>merge</i>.
Tu commences à me plaire Enzo! GitHub est un site web sur lequel tu peux héberger des projets libres ou open-source (si tu ne connais pas la différence, voici <ahref="https://www.gnu.org/philosophy/open-source-misses-the-point.fr.html">un article</a> pour t’aider à comprendre, et <ahref="https://www.gnu.org/philosophy/free-software-for-freedom.fr.html">un autre</a> pour la route). C’est en particulier orienté pour les projets gérés par git, ce qui tombe bien car c’est ce qu’on utilise. Cela a pour avantage de pouvoir aisément partager ton code et d’assurer qu’il est bien sauvegardé quelque part d’autre que ton disque dur (un <code>rm -rf</code> est si vite arrivé). Et surtout, ça peut te permettre de collaborer avec d’autres personnes sur le même projet sans te casser la tête.
Ou bien, tu peux télécharger le projet directement via <code>git</code>. Eh oui! git permet de gérer les dépôts dits distants, c’est à dire ceux qui sont hébergés sur un serveur en ligne, comme par exemple sur GitHub. Pour cela, il te faut te munir du lien vers le dépôt git, et le passer en argument de <code>git clone</code>. Par exemple, si tu veux télécharger de dépôt du petit logiciel de chat en réseau que j’ai codé durant ma L2 d’informatique, tu peux exécuter ceci:
Dans ce cas là, c’est simple Brigitte. Il faut que tu te créés un compte sur GitHub, puis tu cliques sur le bouton <code>+</code> et <code>New Repository</code>. Tu lui donnes le nom que tu souhaites (en l’occurrence je le nomme <code>temporary-repo</code> car je vais le supprimer cinq minutes après l’écriture de ces lignes), et tu cliques sur <code>Create Repository</code>. Tu n’ajoutes rien avant, pas de description, pas de <code>.gitignore</code>, RIEN.
Bon ok, ce n’est pas aussi simple que ça. Une fois que tu as lié ton dépôt au dépôt distant, il faudra que tu mettes en ligne tes commits quand tu en auras l’occasion. Pour ce faire, tu n’as qu’à taper <code>git push</code> ; et la première fois, il faudra que tu indiques à ton dépôt où mettre en ligne précisément dans le dépôt distant, auquel cas tu ajoutes <code>-u origin master</code> pour cette première fois. Git te demandera donc tes identifiants GitHub pour pouvoir mettre tout ça en ligne.
Branch 'master' set up to track remote branch 'master' from 'origin'.
</pre>
</div>
<p>
Bon, là en nom d’utilisateur y’a le mien, faudra remplacer avec le tiens. Et ouais, ma vitesse de mise en ligne n’est pas fameuse, je suis sur une connexion 3G+ à l’heure où j’écris ces lignes, ne me juge pas. Bref, toujours est-il que je viens de mettre en ligne les fichiers du dépôt sur GitHub. Pas la peine de chercher le mien sur GitHub par contre, ça fera un bail que je l’aurai supprimé au moment où tu liras ces lignes.
Pour faire un exemple, je viens de créer un <code>README.md</code> sur GitHub directement. Ce type de fichiers est assez standard afin de présenter plus ou moins en détails le dépôt et le projet qui y est lié, et son contenu apparaîtra formatté sur la page du dépôt sur GitHub s’il est au format <code>.md</code> (Markdown) ou <code>.org</code> (org-mode, le Markdown d’Emacs avec lequel est écrit ce tutoriel). Mais il n’est pas présent dans mon dépôt local, du coup je vais devoir le récupérer. On va donc entrer <code>git pull</code>.
Là, c’est un problème qui aurait pu être évité avec l’usage des branches dont je t’avais parlé plus haut, mais visiblement, vous êtes sur la même branche. Pas bien. Dans ce cas-là, met-toi d’accord avec Ginette pour savoir qui fait ses push en premier. Si le choix tombe sur Ginette, ou si elle a imposé sa vision des choses et a fait son push avant toi, GitHub va râler car tu n’es pas à jour. Dans ce cas ne panique pas, si tu n’as pas fait tes commits, lance la commande <code>git stash</code> ; ça va sauvegarder tes modifications dans un coin à part et va annuler tes modifications. Va sur <i>ta</i> branche sur laquelle Ginette n’est pas en train de travailler, voire créé-en une nouvelle avec <code>git checkout -b tanouvellebranche</code>, et exécute <code>git stash pop</code> pour rétablir tes modifications sur cette branche.
Du calme Jean-Célestin. Cela veut tout simplement dire que tu n’as tout simplement pas les droits d’écriture sur son dépôt. Du coup, soit tu peux lui demander directement à ce qu’elle te donne les droits d’écriture si elle a confiance en toi, soit tu peux créer un fork puis une pull-request sur GitHub depuis ton fork où tu auras fait tes modifications.
Ouhlà Billy, il va falloir remettre les choses au clair. Là il s’agit de quelque chose de spécifique à GitHub qu’à Git (d’où le fait qu’on en discute dans ce chapitre que le précédent).
</p>
<p>
Sur GitHub, il est possible de copier vers ton profil le dépôt de quelqu’un d’autre dans l’état où il est au moment du fork. Cela inclus les fichiers du <code>master</code>, mais également de toutes les branches du dépôt. Tu peux y penser en terme de super-branche dont tu deviens le propriétaire. Tu peux ainsi travailler comme bon te semble sur le code source sans que son propriétaire ne vienne t’engueuler car tu es en train de polluer sa base de code.
</p>
<p>
Si jamais il y a une modification dont tu es particulièrement fier, tu peux la soumettre au propriétaire du dépôt original (et à ses modérateurs et contributeurs s’il y en a) via ce qu’on appelle une pull-request. Cela signifie donc que tu demandes l’autorisation d’ajouter des commits à la base de code, et ces commits peuvent être lus et commentés par le propriétaire ou les modérateurs. Il peut y avoir une discussion entre toi et les autres personnes qui ont leur mot à dire, le code peut être temporairement refusé, auquel cas tu peux reproposer de nouveau commits sur la même pull-request jusqu’à ce que ton code soit définitivement accepté ou refusé. Dans tous les cas, cela mènera à la fermeture de ta pull-request, et tu pourras fièrement annoncer que tu as participé à un projet sur GitHub, ou bien avouer avec toute la honte du monde qu’il a été refusé.
Eh bien dans ce cas-là, ouvre une <i>issue</i> Bernadette; <i>issue</i> qui en français veut dire <i>problème</i>. Il s’agit d’un système de GitHub te permettant de signaler quelque chose aux propriétaires du dépôt, il peut s’agir d’un bug, d’une demande de fonctionnalité ou de proposition de modification d’autres fonctionnalités. Cela peut donner lieu à des discussions menant à la compréhension du bug, ou à une amélioration de ta proposition.
</p>
<p>
Si tu soumets un bug, avant d’ouvrir une nouvelle <i>issue</i>, assure-toi de bien savoir comment le bug se produit et peut se reproduire. Est-ce que le bug apparaît si tu utilise ou ouvre le logiciel d’une autre façon? Est-ce que le bug apparaît ailleurs? Est-tu sûr que le bug soit un bug? Et si tu décides de le partager, assure-toi de partager un maximum d’information et tout ce que tu sais sur ce bug, en particulier les étapes et conditions pour le reproduire.
Comme j’en avais parlé plus haut, il est possible de configurer git de façon un peu plus poussée que simplement déclarer notre nom et notre adresse email dans notre <code>~/.gitconfig</code>. Il est par exemple possible de déclarer notre éditeur texte préféré, notre navigateur par défaut ou bien même des raccourcis qui pourront t’être bien utile. Ci dessous je te met une partie de mon fichier de configuration avec quelques-unes de mes préférences et pas mal de mes alias.
<dt><code>a</code></dt><dd>Permet d’ajouter d’un coup tout nouveau fichier d’un dépôt en préparation au commit. On peut faire la même chose avec <code>git add .</code> si on est à la racine du dépôt.</dd>
<dt><code>c</code></dt><dd>Un raccourci pour <code>commit</code>, ça permet d’éviter quelques frappes de clavier d’écrire <code>git c</code> plutôt que <code>git commit</code></dd>
<dt><code>cm</code></dt><dd>De même pour <code>cm</code> qui évite de devoir écrire <code>commit -m</code>. On n’a plus qu’à écrire directement le message de commit après <code>cm</code>.</dd>
<dt><code>cam</code></dt><dd>Non, ce n’est pas un plan, c’est le même alias que <code>cm</code> mais qui en plus met automatiquement tous les fichiers modifiés ou supprimés, donc s’il n’y a pas de nouveau fichier à ajouter, même pas besoin de passer par un <code>git a</code> avant le <code>git cam "j’aime les pâtes"</code>.</dd>
<dt><code>co</code></dt><dd>Pour aller plus vite quand on veut écrire <code>checkout</code>.</dd>
<dt><code>cob</code></dt><dd>Et pour en plus rajouter le flag <code>-b</code> pour la création d’une nouvelle branche.</dd>
<dt><code>cl</code></dt><dd>Pour quand tu voudras télécharger ce tutoriel en tapant <code>git cl https://github.com/Phundrak/tutoriel-git.git</code> plutôt que <code>git clone https://github.com/Phundrak/tutoriel-git.git</code>.</dd>
<dt><code>l</code></dt><dd>Te permet d’avoir le log un peu plus sympa et compact dont j’avais parlé plus haut.</dd>
<dt><code>ps</code></dt><dd>Pour faire un push plus rapidement.</dd>
<dt><code>pl</code></dt><dd>Et pour télécharger les derniers commits sur le dépôt plus rapidement.</dd>
<dt><code>re</code></dt><dd>Pour réinitialiser plus rapidement.</dd>
<dt><code>s</code></dt><dd>Pour rapidement savoir où tu en es dans ton dépôt, savoir ce qui a été modifié, ajouté, supprimé, déplacé, tout ça…</dd>
<dt><code>staged</code></dt><dd>Eh oui, Git n’a pas de fonction dédiée pour lister les fichiers en staging, du coup la voilà.</dd>
<dt><code>st</code></dt><dd>Pour sauvegarder tes modifications sur le stash plus rapidement.</dd>
<dt><code>sc</code></dt><dd>Pour supprimer ton stash plus rapidement.</dd>
<dt><code>sp</code></dt><dd>Pour rétablir le stash sur la branche courante plus rapidement.</dd>
<dt><code>sw</code></dt><dd>Pour rapidement savoir ce qu’il y a sur le stash.</dd>
C’est déjà pas mal! Mais non, ce n’est certainement pas tout. Cependant, ce tutoriel n’a pour but de t’apprendre que les bases de Git et de GitHub, pas de tout t’apprendre! Si tu souhaites aller plus loin, connaitre plus de commandes (comme <code>git blame</code> ou <code>git reset</code>), ou bien connaître plus d’options, je ne peux que t’inviter à aller te documenter par toi-même sur le site de Git qui se trouve <ahref="https://git-scm.com/">ici</a>, ou bien à consulter des pages de manuel dans ton terminal via <code>man git</code>, <code>man git-apply</code> ou <code>man-cherry-pick</code> (oui, il faut lier <code>git</code> et le nom de la commande par un tiret d’union).
</p>
<p>
Si jamais tu as une question, n’hésite pas à m’envoyer un mail à <ahref="mailto://phundrak@phundrak.fr">phundrak@phundrak.fr</a>. Si jamais tu trouves une erreur dans ce que je viens de dire dans ce tutoriel, ou si tu as une suggestion, c’est justement le moment de mettre en pratique ce que tu as lu un peu plus haut et d’ouvrir une <i>issue</i> sur GitHub sur <ahref="https://github.com/Phundrak/tutoriel-git">le dépôt de ce tutoriel</a>.
