Mettre l’article sur GitHub

Initialisation, fichiers auxiliaires ignorés, dépôt privé et habitudes qui gardent les fusions entre coauteurs saines.

Mettre l’article sur GitHub

Un manuscrit LaTeX est du texte brut, ce qui convient parfaitement à Git. Chaque brouillon devient un commit auquel vous pouvez revenir, chaque modification est visible sous forme de diff ligne par ligne, et GitHub vous donne une copie hors site ainsi qu’un moyen pour vos coauteurs de récupérer l’état actuel. Rien de tout cela n’exige de maîtriser Git à fond. Un article a besoin d’environ cinq commandes, utilisées avec constance.

La configuration initiale

Fenêtre de terminal
git init
# add a .gitignore for *.aux *.log *.out *.toc *.synctex.gz
git add main.tex refs.bib figures/
git commit -m "Initial manuscript"
gh repo create my-paper --private --source=. --push

Exécutez ceci une fois dans le dossier du projet. L’étape du .gitignore compte plus qu’il n’y paraît. Chaque compilation régénère les fichiers .aux, .log, .out, .toc et .synctex.gz, et les ajouter aux commits noie vos vrais changements sous le bruit généré par la machine et crée des conflits de fusion inutiles entre coauteurs. Ne suivez que ce que vous écrivez : les sources .tex, la base .bib, les figures et les fichiers de classe ou de style fournis par la revue ou la conférence. Le PDF est lui aussi un produit de compilation. La plupart des équipes ne l’incluent pas et le reconstruisent en local, même si l’attacher à une release étiquetée est un bon moyen de figer une version soumise. Gardez le dépôt privé tant que le travail n’est pas public. Un manuscrit non publié n’a pas à être indexé.

Des habitudes qui préservent la sérénité des coauteurs

Faites de chaque commit un changement logique, par exemple « revoir l’intro de la section 3 » ou « ajouter le tableau d’ablation ». L’historique se lit alors comme le récit de l’article, et une mauvaise modification peut être annulée sans dégâts collatéraux. Faites un pull avant de commencer une session d’écriture et un push quand vous vous arrêtez. Les conflits de fusion croissent avec le temps que les branches passent séparées. Ne faites jamais de push forcé sur une branche partagée dès que vos coauteurs l’ont récupérée : cela réécrit l’historique sous leurs pieds. Gardez les gros artefacts binaires (jeux de données, vidéos) hors du dépôt de l’article. Faites un lien vers une archive ou utilisez un dépôt de données séparé. Git conserve éternellement chaque version de chaque binaire.

Une habitude propre à LaTeX : écrire une phrase par ligne de source rend les diffs bien plus lisibles, car la modification d’un seul mot apparaît comme un changement d’une ligne plutôt que comme un paragraphe entièrement réagencé.

Comment Oleafly s’intègre

Chaque projet Oleafly est un dossier ordinaire sur le disque, ces commandes fonctionnent donc dessus sans modification. Oleafly conserve les compilations réussies éligibles dont la source a changé dans les Points de contrôle enregistrés, séparément de Git. Faites vos commits volontaires dans Contrôle de version, puis faites des push et des pull avec vos collaborateurs. Voir l’historique Git. Pour les modes de collaboration construits là-dessus, notamment l’échange de patchs et l’attribution des chapitres, voir Coécrire sans curseur en direct.

Retour à L'atelier local