Création d’un dépôt Git

Le fichier source d’un notebook un fichier texte. L’utilisation des forges logicielles (GitHub, GitLab…) est donc adaptée au stockage, partage et travail collaboratif sur les fichiers source des notebooks. De plus, la fonctionnalité des GitPages offerte par les forges permet de déployer les documents HTMl générés et de le rendre consultables sur le web.


A.Création d’un dépôt vide

Pour mettre en ligne votre notebook sur une forge logicielle, commencez par créer un dépot vide. Sur l’instance Gitlab de l’UAR GRICAD :

  1. Créez un nouveau projet (ou dépôt) Gitlab : New project > Create blank project
    1. Choisissez un nom
    2. Choisissez le niveau de visibilité de projet (privé, interne ou public)
    3. Décochez la case Initialize repository with a README

Exemple :


B. Ajout du projet Rstudio sur le dépôt

Clef SSH

L’utilisation de Git (GitHub, GitLab…) est largement facilitée par la création d’une clef SSH qui sécurise et facilite les authentifications.
Pour installer une clef SSH : https://dphn.parisgeo.cnrs.fr/formation/doc/Workshop_GIT.pdf

Pour ajoutez le contenu de votre projet Rstudio contenant votre notebook (fichier(s) source(s), fichier(s) HTML compilé(s) et fichier(s) annexe(s)), vous pouvez utiliser les lignes de comamnde suivantes dans un terminal :

1. Pointez dans votre répertoire projet (local):

Le terminal Rstudio

Un terminal est mis à disposition dans l’interface Rstudio. Par défaut, ce terminal pointe directement à la racine du projet Rstudio ouvert. Ainsi, il n’est pas nécessaire de réaliser cette étape !

Sinon, utilisez la commande cd :

cd /.../folder_de_votre_projet

2. Configurez ce répertoire comme un projet Git (ou Git repository)

git init --initial-branch=main

3. Reliez-le au project GitLab vide que vous avez créé.

Récupérez le lien SSH sur la page du dépôt ciblé, en cliquant le boutton “Code” :

Puis utilisez la commande git remote add origin complétée par ce lien. Exemple :

git remote add origin git@gricad-gitlab.univ-grenoble-alpes.fr:...git

4. Ajoutez tous les fichiers de votre repertoire local pour qu’ils soient pris en compte dans le versionnage.

git add .

5. Réalisez un commit en indiquant le message de votre choix entre guillemets. Exemple :

git commit -m "Initial commit"

6. Terminez par poussez vos modifications dans le project GitLab en ligne.

git push --set-upstream origin main

Tous les fichiers de votre répertoire local ont été “poussés” dans le project GitLab que vous avez créé, exemple :


Et voilà 💥, vous partagez désormais le code source de votre notebook sur une forge logicielle et vous êtes prêt·e à le déployer sur le web !