Ajouter des fichiers au dépôt

• Pour ajouter des fichiers au dépôt, il faut utiliser la commande suivante :

git add <nom du fichier>

Les fichiers ajoutés sont ainsi placés dans la zone de transit (staging area).

Qu'est-ce que la zone de transit ?

• La zone de transit est un espace de stockage temporaire qui permet de préparer les fichiers à être commités.
• Elle permet de sélectionner les fichiers à ajouter au prochain commit.

source: mdwithml

Commiter les fichiers

Un commit est une validation des modifications effectuées sur les fichiers du projet. Celui-ci est identifié par un hash SHA-1 et contient les informations suivantes :

• L'auteur du commit
• La date du commit
• Le message du commit
• Les fichiers modifiés.

Lorsque l'on clone un dépôt Git, on récupère l'ensemble des commits du projet.

Il existe de nombreux services qui permettent d'héberger des dépôts Git :

• GitHub (le plus connu)
• GitLab (le plus complet)

Ces sites sont des plateformes de collaboration qui permettent de travailler à plusieurs sur un même projet. On y retrouve de nombreux projets open source accessibles à tous.

Pour envoyer les commits sur un serveur distant, il faut utiliser la commande suivante :

git branch -M main # Renomme la branche actuelle en "main"
git remote add origin git@github.com:QJoly/PrezGit.git # Ajoute le serveur distant "origin"
git push -u origin main # Envoie les commits sur le serveur distant

Qu'en est-il du cas où nous travaillons à plusieurs sur un même projet ?

• Il est nécessaire de récupérer les commits (modifications) des autres collaborateurs avant de pouvoir envoyer les siens.
• Besoin de pouvoir gérer les conflits lorsque deux collaborateurs ont modifié le même fichier.

Pour récupérer les commits des autres collaborateurs, il faut utiliser la commande suivante :

git pull

Les branches

Une branche est une version parallèle du projet. Elle permet de travailler sur une fonctionnalité sans impacter le reste du projet avant de la fusionner avec la branche principale ou de maintenir une version alternative.

Une fois le code terminé, il suffit de fusionner la branche avec la branche principale pour l'intégrer au code 'stable'.

Il convient de nommer une branche avec le type de modification apportée (fix, feat, chore).

Changer de branche

• Pour changer de branche, il faut utiliser la commande suivante :

git checkout <nom de la branche>

• Pour voir la liste des branches, il faut utiliser la commande suivante :

git branch

• Pour créer une nouvelle branche, il faut utiliser la commande suivante :

git checkout -b <nom de la branche>

Fusionner des branches

Pour fusionner une branche avec la branche principale, il faut utiliser la commande suivante :

git merge <nom de la branche>
# exemple
git merge feat/ajout-fichier

Cela va avoir pour effet de créer un nouveau commit qui contiendra les modifications de la branche feat/ajout-fichier vers la branche sur laquelle on se trouve.

Proposer des modifications

Lorsque l'on travaille sur un projet open source, il est nécessaire de pouvoir proposer des modifications au projet. On appelle cela une pull request (PR) ou une merge request (MR).
note: les deux termes sont utilisés selon la plateforme utilisée (GitHub ou GitLab) mais représentent la même chose.

Il faut alors créer une branche qui contiendra les modifications à apporter au projet. Une fois les modifications terminées, il faut envoyer la branche sur le serveur distant et créer une PR/MR.

Un mainteneur du projet pourra alors valider, ou réclamer des modifications, avant de fusionner la branche avec la branche principale.

Pour créer une MR/PR, il faut procéder aux étapes suivantes :

• Créer une branche (ou un fork si vous n'avez pas un accès en écriture au dépôt)
• Ajouter les modifications
• Envoyer la branche sur le serveur distant
• Créer une MR/PR via l'interface web (github/gitlab)

Quelques règles à retenir :

• Détaillez les modifications apportées.
• Ajoutez des images/log si nécessaire.
• Ajoutez des labels*.
• Soyez courtois et patient.

Les labels sont des "étiquettes" qui permettent de catégoriser les MR/PR et de les retrouver plus facilement (ex: bug, enhancement, etc.).

Gérer les conflits

Lorsque l'on travaille à plusieurs sur un même projet, il est possible que deux collaborateurs aient modifié le même fichier. Dans ce cas, il y a un conflit.

Pour résoudre un conflit, Git vous place dans un état spécial appelé "état de conflit". Il faut alors ouvrir le fichier en conflit et résoudre le conflit manuellement. Une fois le conflit résolu, il faut ajouter le fichier au prochain commit.

En modifiant le fichier, on supprime les marqueurs de conflit (<<<<<<<, =======, >>>>>>>) et on garde uniquement le code que l'on souhaite conserver.

Annuler un commit

Il existe plusieurs méthodes pour annuler un commit :

• Ajouter un commit en annulant un autre (revert)
• Forcer la suppression d'un commit avec perte de l'historique (rebase)

Attention, si je souhaite modifier un fichier ayant eu plusieurs commits : il y aura des conflits.

Annuler un commit via un revert

cd $(mktemp -d) && git init
for i in `seq -w 1 3`; do echo "$i" > "$i" ; git add "$i"; git commit -m "$i"; done;
# Je souhaite supprimer le commit créant le fichier "2"
git revert HEAD^ # HEAD^ = avant-dernier commit
ls
1 3
# le fichier "2" est bien supprimé

Annuler un commit via un rebase

Pour annuler un commit via un rebase, il faut utiliser les commandes suivantes :

cd $(mktemp -d) && git init
for i in `seq -w 1 3`; do echo "$i" > "$i" ; git add "$i"; git commit -m "$i"; done;
# Je souhaite supprimer le commit créant le fichier "2"
git rebase -i HEAD~3
# Changer "pick" en "drop" pour le commit à supprimer
git log
# Le commit est bien supprimé

rebase peut aussi être utilisé pour fusionner des commits, ou modifier l'ordre des modifications.

Attention, l'usage de rebase peut être dangereux. Des pertes de données peuvent survenir avec une mauvaise manipulation.

Modifier la branche du dernier commit

# Annuler le précédent commit, mais garder les modifications
git reset HEAD~ --soft
git stash
# modification sauvegardée dans stash, se placer sur la bonne branche
git checkout bonneBranche
git stash pop
git add .
git commit -m "Ma modification ici";

Ajouter des modifications au dernier commit

for i in `seq -w 1 3`; do echo "$i" | tee -a FICHIER; done;
git add . ; git commit -m "Création des fichiers 1, 2 et 3"
# Je souhaite ajouter "4" au fichier.. mais le commit est déjà fait
echo "4" | tee -a FICHIER
git add .
git commit --amend
git log

Le --amend va alors vous ouvrir une fenêtre pour refaire le commit (à partir des fichiers ajoutés via git add), c'est aussi l'occasion de modifier le message du commit si vous le souhaitez.

Sauvegarder des modifications non commitées (stash)

Admettons que vous soyez en train de bosser sur une fonctionnalité avant d'être interrompu pour corriger un bug sur une autre branche.

Plutôt que de commit des modifications incomplètes, vous pouvez utiliser un stash qui va sauvegarder vos modifications non commitées.

git stash
git stash pop # Applique les fichiers, et supprime la pile
git stash apply # Applique les fichiers en gardant la pile

Squasher des commits

Pour augmenter la lisibilité dans l'historique de commit git log, il peut être intéressant de fusionner des commits. On appelle ça un squash.

Pour fusionner les 3 derniers commits:

git rebase -i HEAD~3

Vous aurez la liste des 6 commits, laissez le premier à pick et modifier les autres en squash. Cela aura pour effet de supprimer 5 commits pour n'en garder qu'un.

Vous pouvez aussi modifier le message du commit.

les tags

Les tags sont des références vers un commit. Ils permettent de marquer un commit comme étant une version stable du projet. On l'utilise habituellement pour marquer les versions du projet (ex: v1.0.0) avant une release.

Pour créer un tag local, il faut utiliser la commande suivante :

git tag <nom du tag> [hash du commit]
# exemple: git tag v1.0.0

Pour créer un tag sur le serveur distant, il faut utiliser la commande suivante :

git tag -a <nom du tag> -m "Message du tag"
# exemple: git tag -a v1.0.0 -m "Version 1.0.0"
git push origin <nom du tag>

Les tags permettent de concerver d'anciennes versions du projet et de comparer les modifications entre deux versions.

Lorsqu'on souhaite comparer deux versions, il faut utiliser la commande suivante :

git diff <tag1> <tag2>
# exemple: git diff v1.0.0 v1.1.0

Lorsqu'une version doit être livrée au client, on parle de release.

Release

Une release est une version du projet qui est livrée au client. Elle est généralement marquée par un tag et contient les sources du projet et/ou les livrables (ex: .deb, .rpm, .exe, etc.).

Pour créer une release, il faut procéder aux étapes suivantes :

• Créer un tag
• Créer une release sur le serveur distant

Git ne veut pas push mes commits

To github.com:QJoly/PrezGit.git
 ! [rejected]        test/sandbox -> test/sandbox (fetch first)
erreur : impossible de pousser des références vers 'github.com:QJoly/PrezGit.git'
astuce: Les mises à jour ont été rejetées car le distant contient du travail que vous
astuce: n'avez pas localement. La cause probable est que quelqu'un a déjà poussé sur la même réf.
astuce: depuis un autre dépôt. Si vous souhaitez intégrer les changements distants,
astuce: "utilisez 'git pull' avant de pousser à nouveau.
astuce: Voir la 'Note à propos des avances rapides' dans 'git push --help' pour plus d'information.

La raison est qu'il existe un commit sur le serveur distant que je n'ai pas récupéré en local. Je dois faire un git pull avant de pouvoir push mes commits.

Je ne peux pas changer de branche !

$ git switch main       
erreur : Vos modifications locales aux fichiers suivants seraient écrasées par l'extraction :
        slide-deck.md
Veuillez valider ou remiser vos modifications avant de basculer de branche.
Abandon

La raison est que j'ai des modifications non commitées sur la branche actuelle. Je dois soit les commits, soit les supprimer, soit les garder en mémoire avec un git stash.

Ma tête (HEAD) est détachée !

git status          
HEAD détachée sur e1dba84
rien à valider, la copie de travail est propre
➜  PrezGit git:(20) git pull  
Vous n'êtes actuellement sur aucune branche.
Veuillez spécifier sur quelle branche vous souhaiter rebaser.
Référez-vous à git-pull(1) pour de plus amples détails.

    git pull <distant> <branche>

Je suis dans un état spécial appelé "HEAD détachée". Cela signifie que je ne suis pas sur une branche. Je dois me placer sur une branche pour pouvoir travailler : git checkout main

Impossible de pull

astuce: Vous avez des branches divergentes et vous devez spécifier comment
astuce: les réconcilier. Vous pouvez le faire en lançant une des
astuce: commandes suivantes avant votre prochain tirage :
astuce:   git config pull.rebase false  # fusion
astuce:   git config pull.rebase true   # rebasage
astuce:   git config pull.ff only       # avance rapide seulement
# [..]
fatal : Besoin de spécifier comment réconcilier des branches divergentes.

Ce message est dû au fonctionnement interne du pull (en réalité : c'est un fetch puis merge). Je vous conseille de passer par l'option 2 git config pull.rebase true qui va fusionner les modifications distantes avec les vôtres.

pull.ff ne tolère pas les conflits, et pull.rebase false créera des commits de fusion indésirables`