Ce document est particulièrement important si vous suivez le parcours RStudio ou Org-Mode. Vous pouvez l’ignorer dans un premier temps si vous suivez le parcours Jupyter car nous avons étroitement intégré Jupyter et GitLab dans le contexte de ce MOOC.
Jusqu'à présent, vous avez utilisé Git uniquement via l'interface web du GitLab que nous avons déployée pour le MOOC : https://app-learninglab.inria.fr/gitlab/
Si vous accédez à ce lien depuis la plate-forme FUN, vous n'avez pas à vous authentifier et vous pouvez facilement lire et modifier tous vos fichiers. C'est très pratique, mais dans la plupart des cas, vous voudrez avoir votre propre copie locale du référentiel et vous devrez synchroniser votre copie locale avec celle de GitLab. Vous devrez évidemment vous authentifier sur GitLab pour propager vos modifications.
Ce document décrit le logiciel que vous devez installer sur votre ordinateur et comment gérer l'authentification. La section "Configuration de Git" est illustrée dans un tutoriel vidéo (en français).
Veuillez lire attentivement toutes ces instructions, en particulier celle sur la "Configuration de votre mot de passe sur GitLab".
Nous ne fournissons ici que des instructions pour les distributions basées sur Debian. N'hésitez pas à contribuer à ce document en fournissant des informations à jour sur les autres distributions (RedHat, Fedora, par exemple).
Run (as root) :
Git dans la variable PATH de Windows. La façon de procéder est très bien expliquée ici.Semble fonctionner avec GitLab et https (voir discussion).
Ouvrir un terminal.
Définir un nom d'utilisateur et un email dans Git :
git config --global user.name "Mona Lisa"
git config --global user.email "email@example.com"
Ces deux paramètres sont obligatoire pour pouvoir commiter sinon vous obtiendrez le message suivant:
Confirmer que vous avez correctement défini le nom d'utilisateur et l'email Git :
git config --global user.name
git config --global user.email
Mona Lisa
email@example.com
Vous êtes peut-être derrière un proxy, auquel cas vous pouvez avoir des problèmes de clonage ou d’extraction à partir d’un dépôt distant, ou une erreur telle que : unable to access... Couldn't resolve host...
Dans ce cas, envisagez quelque chose comme ceci :
git config --global http.proxy http://proxyUsername:proxyPassword@proxy.server.com:port
Le proxyPassword sera stocké en texte brut (non crypté) dans votre fichier .gitconfig, ce que vous ne souhaitez peut-être pas. Dans ce cas, supprimez-le de l'URL et vous serez invité à le saisir chaque fois que vous en aurez besoin.
Pour effacer l'utilisation de ce proxy, il vous suffit d'utiliser cette commande :
git config --global --unset http.proxy
Avertissement (utilisateurs Jupyter) : changer votre mot de passe Gitlab par défaut vous empêchera de commiter les notebooks Jupyter que nous avons déployés pour le MOOC. Vous devrez effectuer l’étape supplémentaire de modification de votre ~/.git-credentials dans l’environnement Jupyter (éventuellement plusieurs fois).
Récupérer votre mot de passe par défaut en utilisant l'outil Gitlab credentials retrieval comme décrit dans la ressource correspondante.
La première séquence de caractères longue et laide est votre identifiant GitLab qu'il est facile de trouver une fois que vous êtes connecté à Gitlab. Cependant la seconde séquence de caractères est votre mot de passe et cette page Web est le seul endroit où vous pouvez le trouver. Nous avons utilisé le mécanisme d'authentification FUN pour propager vos informations d'identification de sorte que seulement vous puissiez y accéder. Vous devrez utiliser ce mot de passe lorsque vous essaierez de propager des modifications de votre ordinateur vers GitLab.
Note : Vous devez accéder à cette page Web à partir de la plate-forme FUN, sinon vous risquez d'obtenir une erreur 405 en essayant d'accéder directement à https://app-learninglab.inria.fr/jupyterhub/services/password.
Accéder à GitLab.
Note : Vous devez à nouveau accéder à Gitlab à partir de la plate-forme FUN, sinon vous risquez d'obtenir une erreur 405 en essayant d'accéder directement à https://app-learninglab.inria.fr/gitlab/users/sign_in/.
Cliquez sur le premier bouton Sign in. Vous pouvez également utiliser l'identifiant/mot de passe que vous venez de récupérer et utiliser le second bouton Sign in. Le second bouton permet de plus de se connecter sans passer par la plateforme FUN une fois que vous connaissez votre identifiant/mot de passe.
Si vous souhaitez modifier votre mot de passe, accédez à Account > Settings > Password et définissez votre mot de passe à l'aide du mot de passe par défaut que vous venez de récupérer. Encore une fois, si vous utilisez les notebooks Jupyter que nous avons déployés pour le MOOC, n’oubliez pas que changer votre mot de passe Gitlab par défaut vous empêchera de les commiter. Vous devrez effectuer l’étape supplémentaire consistant à changer votre ~/.git-credentials Jupyter via une console Jupyter (voir section suivante).
Si vous clonez votre dépôt en collant simplement l'URL de GitLab, vous serez invité à saisir votre identifiant et votre mot de passe chaque fois que vous souhaitez propager vos modifications locales, ce qui est fastidieux. C’est pourquoi vous pouvez demander à Git de se rappeler de votre identifiant et votre mot de passe comme suit :
git config --global credential.helper cache # remember my password
git config --global credential.helper "cache --timeout=3600" # for one hour at most
Avec cette configuration, vous serez invité à saisir votre mot de passe, mais celui-ci sera mis en cache et ne sera plus demandé pendant une heure. Vous voudrez peut-être lire ces instructions pour mieux comprendre comment tout cela fonctionne.
Si vous souhaitez que votre mot de passe soit mémorisé en permanence, vous devez utiliser cette commande :
git config credential.helper store
Votre mot de passe sera alors stocké dans un fichier .git-credentials en texte brut (non-crypté). Sur une machine parfaitement sécurisée, cela peut être très bien… ou pas… ;) Utilisez cette possibilité à vos risques et périls.
Si vous souhaitez effacer les mots de passe enregistrés, il vous suffit d'utiliser cette commande :
git config --system --unset credential.helper
Enfin, il peut arriver que vous ayez le message d'erreur suivant sous Windows :
git: 'credential-cache' is not a git command. See 'get --help'.
Ce problème est évoqué sur stackoverflow. Dans ce cas, tentez la commande suivante :
git config --global --unset credential.helper
Si ça ne marche toujours pas, n'hésitez pas à décrire votre problème sur le forum du MOOC.
Il existe deux manières d'authentifier et de synchroniser votre dépôt local avec GitLab : via HTTPS ou via SSH. Le premier est ce qui vient d'être décrit et ne nécessite aucune installation de logiciel particulier sur votre machine, c'est donc ce que je recommande pour ce MOOC. Pourtant, je préfère le second (bien que cela puisse paraître un peu plus technique), c'est pourquoi je le décris ici. Cela consiste à installer SSH, à créer une paire de clés ou des clés privée/publique et à télécharger votre clé publique SSH sur GitLab. Cette section fournit des informations sur la procédure à suivre.
Linux (Debian, Ubuntu)
Nous ne fournissons ici que des instructions pour les distributions basées sur Debian. N'hésitez pas à contribuer à ce document en fournissant des informations à jour sur les autres distributions (RedHat, Fedora, par exemple).
Run (as root) :
macOS
C'est installé par défaut donc vous n'avez rien à faire.
Windows
Vous devez installer le client Putty. Une fois l’installation terminée, suivez la section PuTTYgen - Key Generator for PuTTY on Windows.
Vous trouverez ici les explications officielles sur la configuration de votre clé SSH sur GitLab. Vous pouvez aussi regarder cette vidéo :
Cette section décrit un moyen générique (par lignes de commandes) de synchroniser vos fichiers locaux avec Gitlab. Vous n'en aurez pas besoin si vous suivez le parcours Jupyter. Si vous suivez le parcours RStudio, toutes ces opérations peuvent être effectuées via RStudio et vous voudrez peut-être lire les instructions correspondantes. Si vous suivez le chemin Org-Mode, toutes ces opérations peuvent être effectuées via Magit et vous voudrez peut-être lire les instructions correspondantes.
Voici d'autres moyens d'apprendre Git par lignes de commandes :
Maintenant, commençons !
Récupérer l'URL du dépôt
Cloner le dépôt
cd /the/directory/where/you/want/to/clone/your/repository
git clone https://app-learninglab.inria.fr/gitlab/xxx/mooc-rr.git
Alternativement, vous pouvez vouloir indiquer votre identifiant maintenant, bien que je vous suggère plutôt de suivre les instructions de la partie Enregistrer votre mot de passe localement.
git clone https://xxx@app-learninglab.inria.fr/gitlab/xxx/mooc-rr.git
Maintenant un répertoire mooc-rr a été créé sur votre ordinateur.
Inspecter le répertoire correspondant au dépôt
cd mooc-rr
ls # (Unix)
dir # (Windows)
Synchroniser avec GitLab
Vous devez indiquer les fichiers à suivre (git add) et les valider localement (git commit) avant de pouvoir les transférer (git push) à GitLab. Le git status vous indiquera si les fichiers sont suivis/modifiés/commités/…
Supposons que vous venez de créer un fichier fichier.txt à la racine du répertoire mooc-rr.
git status
git add fichier.txt
git status
git commit -m "message commit"
git status
Le fichier peut ensuite être transféré vers GitLab :
git push
À ce stade, Git vous demandera votre identifiant/mot de passe, sauf si vous avez suivi les instructions de la partie Enregistrer votre mot de passe localement.
N.B. : vous ne serez pas autorisé à propager vos modifications dans GitLab si d'autres modifications ont été propagées entre temps (par exemple par quelqu'un d'autre).
Synchronisation à partir de Gitlab : pour éviter le problème précédent, vous devez d’abord récupérer les modifications distantes de GitLab et les appliquer localement.
git pull
Alors seulement pourrez-vous exécuter le git push.