Zum Hauptinhalt springen

Einführung

Bevor Sie mit der Entwicklung beginnen, sollten Sie folgende Punkte kennen:
  • Overleaf wird offiziell in einem internen Repository entwickelt, und die Community Edition wird unter overleaf/overleaf veröffentlicht. Ein Copybot ist für die Synchronisierung des Codes zwischen dem internen und dem öffentlichen Repository zuständig.
  • Ayaka-notes/overleaf-pro ist ein Fork der Overleaf Community Edition. Wir möchten, dass dieses Projekt langfristig bestehen bleibt, daher befolgen Sie bitte die Regeln, bevor Sie Beiträge leisten.

Commit-Regeln

  • Bitte nehmen Sie keine umfangreichen Änderungen am bestehenden Overleaf-Code vor. Bündeln Sie so viel Funktionalität wie möglich im Ordner services/web/modules. Dadurch minimieren wir unseren Aufwand beim späteren Zusammenführen und Aktualisieren des Codes.
  • Vibe Coding ist zwar sehr bequem, kann unser Projekt aber leicht durcheinanderbringen und es später unwartbar machen. Setzen Sie es daher bitte mit Bedacht ein.
  • Verwenden Sie nach Möglichkeit vorhandene Übersetzungsschlüssel wieder. Wenn wirklich ein neuer Schlüssel nötig ist, fügen Sie ihn für alle Sprachen auf einmal in services/web/locales/locales_patches/added/ hinzu, siehe i18n-Übersetzungen aktualisieren.
  • Vermeiden Sie neue Umgebungsvariablen, sofern sie nicht unbedingt erforderlich sind. Falls doch, sorgen Sie dafür, dass sie so weit wie möglich mit denen im Overleaf Toolkit oder auf docs.overleaf.com übereinstimmen.

Branch-Regeln

Für die Entwicklung von overleaf-pro verwenden wir die folgenden Branches:
  • main: Dieser Branch dient ausschließlich der Synchronisierung mit dem Upstream-Code. Bitte committen Sie hier KEINE externen Änderungen. In diesem Branch setzen wir Tags wie ce-v[X.x.x], die angeben, dass der Stand v[X.x.x] der offiziellen Overleaf Community Edition entspricht. Hinweis: Diese Tags sind unveränderlich!
  • server-pro: Dies ist der Standard-Branch für die tägliche Entwicklung.
  • feat-X: Dieser Branch wird für die Entwicklung eines bestimmten Features verwendet, zum Beispiel feat-gitea-sync.
  • release-vX.Y.Z: Der Branch speziell für Releases; hier nehmen wir vor dem Release einige Hotfixes vor. Auch Patch-Releases erhalten einen eigenen Branch, zum Beispiel release-v6.3.1. Der veröffentlichte Commit wird auf diesem Branch mit pro-vX.Y.Z getaggt.

Branch-Regeln für Overleaf Pro

GitHub Action

GitHub Action ist für das automatische CI/CD zuständig. Sie müssen keine Images auf Ihrem eigenen Rechner bauen: Jedes der unten aufgeführten Images wird von einem Workflow gebaut, und diejenigen mit manuellem Trigger lassen sich mit einem Klick bauen.
  • Entwicklungs-Images enthalten jeweils einen Microservice (web, webpack, clsi, …) für linux/amd64 und linux/arm64. Das Codespace-Setup bezieht sie über develop/docker-compose.image.yml, anstatt bin/build auszuführen.
  • Operations-Images sind vollständige Single-Container-Images (wie sharelatex/sharelatex), um eine Änderung durchgängig zu testen. ops:latest wird nur bei Pushes auf server-pro aktualisiert; ein PR erhält nur ein Tag mit Zeitstempel. Diese Images werden 7 Tage lang aufbewahrt und sind nur für Tests gedacht.
  • Release-Images sind das, was Benutzer bereitstellen. Die Version ergibt sich aus dem Branch-Namen, sodass release-v6.3.0 das Image overleaf-pro:6.3.0 veröffentlicht.
1

Einen Workflow manuell ausführen

Öffnen Sie den Tab Actions, wählen Sie links den Workflow aus, klicken Sie auf Run workflow und bestätigen Sie. Build Operations Image bietet zusätzlich die Option Build without cache für den Fall, dass ein zwischengespeicherter Layer veraltet ist.
2

In Ihrem Fork bauen

Dieselben Workflows laufen auch in einem Fork: Aktivieren Sie Actions in Ihrem Fork und führen Sie sie dann über dessen Actions-Tab aus. Images werden mit dem integrierten GITHUB_TOKEN nach ghcr.io/<your-name>/overleaf-pro/... gepusht, sodass keine Secrets erforderlich sind. Sync Upstream Code und die Bereinigung alter Images laufen nur in ayaka-notes.Build Release Image benötigt einen release-v*-Branch in Ihrem Fork.
So prüfen Sie, aus welchem Commit ein Image gebaut wurde: Das Tag eines Operations-Images endet mit dem kurzen Commit-Hash, und ein Release-Image trägt ihn im Label com.overleaf.pro.revision (siehe docker inspect in den Fragen & Antworten unten).

Fragen & Antworten

Zunächst müssen Sie das Docker-Image herunterladen und mit dem folgenden Befehl die Labels dieses Docker-Images untersuchen:
bash
Anschließend können Sie prüfen, ob der Commit (b0d05c0) im Upstream-master-Branch vorhanden ist.
Dies ist das erwartete Verhalten. Das Release 6.0.1 ist ein kleines Patch-Release, das auf dem Image 6.0.0 aufbaut. Die Änderungen werden durch Patchen des bestehenden 6.0.0-Images angewendet, anstatt das Image aus einem neuen Commit neu zu erstellen. Daher ist der Commit-Hash im Image bei 6.0.0 und 6.0.1 identisch.Weitere Informationen finden Sie unter hotfix.
Zuletzt geändert am 20. November 2026