index.md 6.9 KB
title: "Tutoriel git" output:
toc: true
Introduction
À qui s'adresse ce tutoriel ?
- Objectif du tutoriel : apprendre à utiliser le système git et le serveur gogs mis en place par le SCOSI.
- Pré-requis : utilisation basique d'un ordinateur.
- Public visé : les développeurs au sens large (code latex, python, matlab, R, java...)
Qu'est-ce-que git et gogs ?
- git : système de journalisation de code source décentralisé (alternative à mercurial, subversion, CVS...)
- gogs : service d'hébergement de code source utilisable avec git (alternative à github, bitbucket...)
Dans quels cas utiliser git/gogs ?
git est conçu pour manipuler principalement des fichiers au format texte (code source, code latex, fichier CSV...). Il permet notamment :
- journalisation
- sauvegarde distante
- synchronisation
- travail en équipe
- projets publics ou privés :
Dans quels cas ne pas utiliser git/gogs ?
- édition collaborative en temps-réel -> sharelatex
- partage de fichiers -> serveur ftp, http...
- fichiers dans un format non textuel (jpg, word, excel...) -> dropbox
Concepts de base
Notion de "version" (commit)
Un "projet git" contient l'historique de toutes les modifications de chaque fichier. On appelle "commit" un état sauvegardé de ces modifications (une version du projet en quelque sorte).
Généralement, on modifie le projet à partir de la version précédente et ansi de suite; ce qui correspond à une succession de commits :
Mais on peut également effectuer des modifications en parallèles. On appelle ça des branches :
On peut ensuite rassembler ces modifications en fusionnant les branches :
Notion de dépôt (repository)
On appelle dépôt l'ensemble des fichiers de notre "projet git", avec l'historique des commits.
Un dépôt peut être dupliqué sur différentes machines, pour synchroniser les données ou pour travailler en équipe.
Dans l'ancien temps des années 2000, on avait un dépôt principal distant que l'on synchronisait ou modifiait via des copies locales partielles (subversion, CVS...) :
Aujourd'hui, on utilise plutôt un système de dépôts décentralisés (git, mercurial...). Avec ce système, tous les dépôts sont identiques et peuvent se synchroniser entre eux :
Généralement, on garde tout de même un dépôt sur un serveur distant accessible en permanence (serveur gogs, github...).
Installation et configuration
Pour utiliser git, il vous faut une connexion internet et un client git.
Installation sous Linux
La plupart des systèmes Linux modernes propose le client git dans leur système de paquets. Par exemple, sur les Linux basés Debian, il suffit de lancer la commande console :
sudo apt-get install git
Il existe également des clients graphiques : gitg, giggle, qgit, gitk, git-gui...
Installation sous Windows ou Mac
Télécharger et installer le client git pour Windows ou le client git pour Mac.
Configuration
Après avoir installé le client git, il faut configurer le nom et l'adresse e-mail de l'utilisateur (à faire une seule). Par exemple, en tapant les commandes consoles :
$ git config --global user.name "Julien Dehos"
$ git config --global user.email dehos@nimpe.org
On peut également configurer l'éditeur de texte et le proxy que le client git doit utiliser. Par exemple, en tapant les commandes consoles :
$ git config --global core.editor emacs
$ git config --global http.proxy http://user:pass@proxyhost:proxyport
ou alors en ajoutant des variables d'environnement (par exemple, dans le
.bashrc):
export EDITOR=emacs
export http_proxy=http://user:pass@proxyhost:proxyport
Obtenir de l'aide
Aide générale sur git :
$ git help
Aide sur une commande git :
$ git help <commande git>
Voir également la section références.
Exercice
Installez et configurez le client git sur votre machine. Vérifiez que votre
client git peut accéder à l'extérieur, par exemple en récupérant le dépôt
distant https://github.com/juliendehos/invinoveritas :
Dépôt local (journaliser un projet)
L'élément de base d'un projet git est le dépôt. Il s'agit simplement d'un dossier classique que l'on demande à git de versionner.
Initialiser un dépôt
Allez dans le dossier à versionner puis lancez la commande git clone.
Git créé alors un dossier .git pour y stocker ses metadonnées. Si vous ne
voulez plus versionner votre dossier, il suffit de supprimer ce dossier. Le
reste du temps, ne touchez pas à ce dossier si vous n'êtes pas absolument
sûr(e) de ce que vous faites.
Afficher l'état d'un dépôt
La commande git status affiche l'état courant du dépôt : nouveaux fichiers,
fichiers modifiés, fichiers supprimés. Cette commande est très sûre; elle ne
peut rien casser. N'hésitez donc pas à la lancer pour voir où vous en êtes.
Ajouter/supprimer des fichiers dans le dépôt
Il faut indiquer explicitement les fichiers que git doit journaliser.
Par exemple, imaginons qu'on ouvre un nouveau fichier rapport_01.tex dans
notre projet.
On y écrit du code latex.
Et on affiche l'état du dépôt.
Git nous indique que le fichier rapport_01.tex existe bien dans le dossier
(ainsi qu'un fichier de sauvegarde), mais qu'il ne fait pas partie du dépôt.
Pour ajouter un fichier au dépôt, il faut utiliser la commande git add.
Ceci indique que git doit prendre en compte le fichier lors des prochains
commits (journalisation), ce qu'on peut vérifier avec un git status.
Valider les modifications (commit)
Afficher l'historique des commits
Revenir à un commit précédent
TODO
Annuler des commits
Bonne pratique concernant la journalisation
.gitignore conseil sur les fichiers générés et les fichiers de données
Exercice
Dépôt distant (sauvegarder un projet sur un serveur)
TODO
nouveau projet
projet existant
Exercice
Branches (travailler en équipe)
TODO
Exercice
Forks (collaborer avec d'autres projets)
Exercice
Références
Dernière mise à jour : 2016-03-05