Introduction
Avant de vous lancer dans le développement, nous espérons que vous comprendrez les points suivants :- Overleaf est officiellement développé dans un dépôt interne, et l’édition communautaire est publiée dans overleaf/overleaf. Un copybot est chargé de synchroniser le code entre les dépôts interne et public.
- Ayaka-notes/overleaf-pro est une version dérivée (fork) de l’édition communautaire d’Overleaf. Nous souhaitons que ce projet s’inscrive dans la durée : merci donc de respecter les règles ci-dessous avant de contribuer.
Règles de commit
- Veuillez ne pas modifier en profondeur le code existant d’Overleaf. Concentrez autant que possible les fonctionnalités dans le dossier
services/web/modules. Cela réduira au minimum notre charge de travail lors des fusions et des mises à jour ultérieures du code. - Le « vibe coding » est certes une méthode très facile, mais il peut aisément semer le désordre dans notre projet et le rendre impossible à maintenir par la suite ; utilisez-le donc avec prudence.
- Réutilisez autant que possible les clés de traduction existantes. Si une nouvelle clé est vraiment nécessaire, ajoutez-la dans
services/web/locales/locales_patches/added/pour toutes les langues à la fois, voir Mettre à jour les traductions i18n. - Évitez d’introduire des variables d’environnement, sauf en cas de nécessité absolue. Si c’est indispensable, veillez à ce qu’elles soient aussi cohérentes que possible avec celles de l’Overleaf Toolkit ou de docs.overleaf.com.
Règles de branches
Nous utilisons les branches suivantes pour le développement d’overleaf-pro :main: cette branche sert uniquement à synchroniser le code amont ; veuillez NE PAS y commiter de modifications externes. Sur cette branche, nous posons des tags tels quece-v[X.x.x], qui indiquent la correspondance avec la versionv[X.x.x]de l’édition communautaire officielle d’Overleaf. Remarque : ces tags sont immuables !server-pro: branche par défaut pour le développement quotidien.feat-X: branche utilisée pour développer une fonctionnalité spécifique, par exemplefeat-gitea-sync.release-vX.Y.Z: branche dédiée à une version ; nous y appliquons des correctifs à chaud avant la publication. Les versions correctives ont aussi leur propre branche, par exemplerelease-v6.3.1. Le commit publié est étiquetépro-vX.Y.Zsur cette branche.

Règles de branches pour Overleaf Pro
GitHub Action
GitHub Action assure le CI/CD automatique. Vous n’avez pas besoin de construire les images sur votre propre machine : chaque image ci-dessous est construite par un workflow, et celles disposant d’un déclenchement manuel peuvent être construites en un clic.- Les images de développement contiennent chacune un microservice (
web,webpack,clsi, …) pourlinux/amd64etlinux/arm64. La configuration Codespace les récupère viadevelop/docker-compose.image.ymlau lieu d’exécuterbin/build. - Les images d’exploitation sont des images complètes à conteneur unique (comme
sharelatex/sharelatex) permettant de tester une modification de bout en bout.ops:latestn’est mis à jour que lors des pushs surserver-pro; une PR reçoit uniquement un tag horodaté. Ces images sont conservées 7 jours et servent uniquement aux tests. - Les images de version sont celles que les utilisateurs déploient. La version provient du nom de la branche : ainsi,
release-v6.3.0publieoverleaf-pro:6.3.0.
1
Exécuter un workflow manuellement
Ouvrez l’onglet Actions, choisissez le workflow à gauche, cliquez sur Run workflow et confirmez. Build Operations Image propose également une option Build without cache lorsqu’une couche en cache est obsolète.
2
Construire dans votre fork
Les mêmes workflows s’exécutent dans un fork : activez Actions dans votre fork, puis lancez-les depuis son onglet Actions. Les images sont poussées vers
ghcr.io/<your-name>/overleaf-pro/... avec le GITHUB_TOKEN intégré, aucun secret n’est donc nécessaire. Sync Upstream Code et le nettoyage des anciennes images ne s’exécutent que dans ayaka-notes.Build Release Image nécessite une branche release-v* dans votre fork.Pour vérifier à partir de quel commit une image a été construite : le tag d’une image d’exploitation se termine par le hash court du commit, et une image de version le porte dans le label
com.overleaf.pro.revision (voir docker inspect dans les questions/réponses ci-dessous).Questions/réponses
Comment trouver le hash de commit de l'édition communautaire d'Overleaf X.0.0 ?
Comment trouver le hash de commit de l'édition communautaire d'Overleaf X.0.0 ?
Tout d’abord, vous devez récupérer l’image Docker et exécuter la commande suivante pour inspecter les labels de cette image :Vous pouvez ensuite vérifier si le commit (b0d05c0) est présent dans la branche master amont.
bash
Pourquoi le hash de commit est-il identique dans l'image CE entre 6.0.0 et 6.0.1 ?
Pourquoi le hash de commit est-il identique dans l'image CE entre 6.0.0 et 6.0.1 ?
C’est un comportement attendu. La version 6.0.1 est un correctif mineur construit sur l’image 6.0.0. Les modifications sont appliquées en corrigeant l’image 6.0.0 existante, au lieu de reconstruire l’image à partir d’un nouveau commit. Par conséquent, le hash de commit contenu dans l’image est identique entre 6.0.0 et 6.0.1.Pour plus de détails, consultez hotfix.

