Introduction
La DIO propose deux logiciels de gestion de version (en anglais Version Control Software ou VCS). Ces outils vous permettent de stocker un ensemble de fichiers en conservant tout l'historique des modifications effectuées. Ils permettent en particulier de pouvoir retrouver toutes les versions des fichiers depuis leur intégration dans le système.
Le but de ce document est de présenter les deux services tels qu'ils sont hébergés par la DIO, mais il ne s'agit pas d'une présentation, ni encore moins d'un mode d'emploi de ces logiciels. Une documentation officielle ainsi que des tutoriels existent et sont bien meilleurs que ce que nous pourrions écrire.
Pour quel usage ?
Ces outils sont indispensables dès qu'il faut produire des fichiers au format texte, seul ou collaborativement, sur une période qui dépasse quelques heures.
Voici deux cas typiques d'usage :
- développement d'un logiciel seul ou à plusieurs ;
- rédaction de TeX/LaTeX (articles, livres, etc.) seul ou à plusieurs.
Services DIO
Parmi les nombreux outils disponibles, la DIO a choisi d'en proposer deux :
- git (VCS décentralisé) 👍
- subversion (VCS centralisé)
Pour chaque catégorie de VCS (centralisé, décentralisé), le choix a été guidé par la popularité, la disponibilité des clients et la capacité à répondre à des utilisations variées.
Lequel choisir ?
L'outil git est celui qui offre le plus de possibilités et de souplesse d'utilisation. Git a toutes les fonctionnalités de subversion, mais pas l'inverse. De plus l'outil GitLab (voir ci-dessous) vous offre énormément de fonctionnalités. Nous vous recommandons donc très fortement l'utilisation de git.
Remarques importantes
Voici quelques remarques générales mais importantes sur l'utilisation de ces outils.
Type de fichiers
Un VCS n'est pas un système de partage de fichiers. Ce qui veut dire qu'il ne faut pas y mettre (ou le moins possible) :
- de fichier binaires (Word/Excel/Powerpoint/PDF/images/etc.) ;
- de gros fichiers (résultats de calcul, etc.).
Ceci sous peine de gros soucis pour vous et pour la DIO.
Nom du projet
Chaque projet doit avoir un nom pour l'identifier et il faut prêter attention dans le choix de ce nom. Il est très fortement conseillé de choisir un nom pas trop court (le moins générique possible), sans espace, sans accent ni caractères spéciaux.
Exemples de nom facilement utilisables :
monprojet
monProjet
developpementCode
developpementCode2
calculPourcent
Exemples de noms à éviter :
mp 1
mon projet
développement de Code
calcul de %
a
Nom des fichiers
Dans le dépôt associé au projet, vous allez mettre des fichiers. Il est très fortement conseillé de faire des noms de fichiers
- sans accent ;
- sans caractère spécial.
À noter aussi que certains systèmes de fichiers (Windows, MacOS) sont insensibles à la casse et considèrent que les deux noms
monfichier
MonFichier
désignent le même fichier. Ainsi, il convient de faire attention au choix des noms des fichiers/dossiers pour ne pas poser de problème aux coauteurs.
Suppression de fichiers
Par construction, un VCS permet de revenir en arrière pour retrouver l'état des fichiers à telle ou telle date, ce qui veut dire qu'il est impossible (subversion) où très complexe (git) de supprimer un fichier dans un dépôt. Ainsi, il faut éviter de rajouter un gros fichier juste pour tester, car le système le conservera de façon définitive, avec un impact sur le stockage et la sauvegarde.
Gitlab
La DIO fournit un service git via
Toute personne de l'Observatoire peut s'authentifier et gérer ses projets via cette interface web.
L'authentification se fait en sélectionnant Observatoire de Paris dans l'écran d'accueil :
Ne pas utiliser l'onglet standard.
Une fois authentifié, cliquer sur le logo (en haut à droite), puis help pour accéder à une description détaillée
et une aide. Attention, tout les services décrits ne sont pas nécessairement disponibles dans la configuration installée par la DIO.
Subversion
Pour des raisons historique la DIO offre la possibilité d'avoir un dépôt sur un serveur accessible depuis tout internet en HTTPS.
Cependant ce service est vieillissant, il est très fortement recommandé d'utiliser la solution GitLab décrit ci-dessus.
La seule condition pour est que le demandeur soit membre de l'Observatoire. Il est possible d'avoir des coauteurs extérieurs.
La création d'un dépôt se fait via une demande au guichet unique de la DIO (admin.dio@obspm.fr) dans laquelle il faut fournir à minima les informations suivantes :
- nom du projet ;
- si le dépôt est en accès pour lecture anonyme ou non ;
- liste des coauteurs membres de l'Observatoire.
S'il y a des coauteurs extérieurs, il faut préciser pour chacun :
- nom, prénom ;
- adresse e-mail ;
le résultat de la commande suivante, exécutée par la personne sur une machine Linux/UNIX, qui lui permettra de choisir un mot de passe et d'en fournir une version « chiffrée » (« hachée », pour être plus précis) :
htpasswd -n -m <login>
En réponse, la DIO informera le demandeur lorsque le dépôt sera prêt et fournira l'URL d'accès.
Remarque : La DIO ne fournit pas de dépôt en écriture de façon anonyme.
Si vous avez déjà un dépôt subversion ailleurs sur un autre serveur, il est en général possible de le transférer sur les serveurs de la DIO. Si vous souhaitez faire une telle opération, contactez le guichet unique de la DIO (admin.dio@obspm.fr).