Naar hoofdinhoud gaan

Introductie

Voordat je met de ontwikkeling begint, willen we graag dat je de volgende zaken begrijpt:
  • Overleaf wordt officieel ontwikkeld in een interne repository, en de community edition wordt gepubliceerd in overleaf/overleaf. Een copybot zorgt voor de synchronisatie van code tussen de interne en de publieke repository.
  • Ayaka-notes/overleaf-pro is een fork van de Overleaf community edition. We hopen dat dit project lang meegaat, dus volg alsjeblieft de regels voordat je een bijdrage levert.

Regels voor commits

  • Breng geen ingrijpende wijzigingen aan in de bestaande Overleaf-code. Concentreer zoveel mogelijk functionaliteit in de map services/web/modules. Zo beperken we het werk bij het later mergen en bijwerken van de code.
  • Vibe coding is inderdaad een erg makkelijke manier van werken, maar het kan het project snel tot een rommeltje maken, waardoor het later onhoudbaar wordt. Gebruik het dus met de nodige voorzichtigheid.
  • Hergebruik waar mogelijk bestaande vertaalsleutels. Als een nieuwe sleutel echt nodig is, voeg die dan voor alle talen tegelijk toe aan services/web/locales/locales_patches/added/, zie i18n-vertalingen bijwerken.
  • Voeg geen nieuwe omgevingsvariabelen toe, tenzij het absoluut noodzakelijk is. Als het toch nodig is, zorg dan dat ze zo veel mogelijk aansluiten bij die in de Overleaf Toolkit of op docs.overleaf.com.

Regels voor branches

We gebruiken de volgende branches voor de ontwikkeling van overleaf-pro:
  • main: Deze branch wordt uitsluitend gebruikt voor het synchroniseren van upstream-code, commit hier GEEN externe wijzigingen. In deze branch zetten we tags zoals ce-v[X.x.x], die aangeven dat dit overeenkomt met v[X.x.x] van de officiële Overleaf Community Edition. Let op: deze tag is onveranderlijk!
  • server-pro: Dit is de standaardbranch voor de dagelijkse ontwikkeling.
  • feat-X: Deze branch wordt gebruikt voor de ontwikkeling van een specifieke feature, bijvoorbeeld feat-gitea-sync.
  • release-vX.Y.Z: Een branch speciaal voor een release; hierin voeren we vóór de release nog enkele hotfixes uit. Ook patchreleases krijgen een eigen branch, bijvoorbeeld release-v6.3.1. De uitgebrachte commit krijgt op deze branch de tag pro-vX.Y.Z.

Regels voor branches in Overleaf Pro

GitHub Action

GitHub Action is verantwoordelijk voor de automatische CI/CD. Je hoeft geen images op je eigen machine te bouwen: elk image hieronder wordt door een workflow gebouwd, en de workflows met een handmatige trigger kun je met één klik uitvoeren.
  • Development-images bevatten elk één microservice (web, webpack, clsi, …) voor linux/amd64 en linux/arm64. De Codespace-setup haalt ze op via develop/docker-compose.image.yml in plaats van bin/build uit te voeren.
  • Operations-images zijn volledige single-container-images (zoals sharelatex/sharelatex) om een wijziging end-to-end te testen. ops:latest wordt alleen bijgewerkt bij pushes naar server-pro; een PR krijgt alleen een tag met tijdstempel. Deze images worden 7 dagen bewaard en zijn alleen bedoeld om te testen.
  • Release-images zijn wat gebruikers uitrollen. De versie komt uit de branchnaam, dus release-v6.3.0 publiceert overleaf-pro:6.3.0.
1

Een workflow handmatig uitvoeren

Open het tabblad Actions, kies links de workflow, klik op Run workflow en bevestig. Build Operations Image heeft ook een optie Build without cache voor wanneer een gecachete laag verouderd is.
2

Bouwen in je fork

Dezelfde workflows draaien ook in een fork: schakel Actions in je fork in en voer ze vervolgens uit vanaf het tabblad Actions daarvan. Images worden naar ghcr.io/<your-name>/overleaf-pro/... gepusht met de ingebouwde GITHUB_TOKEN, dus er zijn geen secrets nodig. Sync Upstream Code en het opruimen van oude images draaien alleen in ayaka-notes.Build Release Image heeft een release-v*-branch in je fork nodig.
Zo controleer je vanuit welke commit een image is gebouwd: de tag van een operations-image eindigt op de korte commit-hash, en een release-image bevat deze in het label com.overleaf.pro.revision (zie docker inspect in de Vragen en antwoorden hieronder).

Vragen en antwoorden

Allereerst moet je de Docker-image pullen en het volgende commando uitvoeren om de labels in deze Docker-image te bekijken:
bash
Daarna kun je controleren of de commit (b0d05c0) aanwezig is in de upstream master-branch.
Dit is verwacht gedrag. De 6.0.1-release is een kleine patchrelease die is gebouwd bovenop de 6.0.0-image. De wijzigingen worden toegepast door de bestaande 6.0.0-image te patchen, in plaats van de image opnieuw te bouwen vanaf een nieuwe commit. Daarom is de commit-hash in de image identiek voor 6.0.0 en 6.0.1.Zie hotfix voor meer informatie.
Laatst gewijzigd op 20 november 2026