Hopp til hovedinnhold

Innledning

Før du går i gang med utvikling, håper vi at du forstår følgende:
  • Overleaf utvikles offisielt i et internt repository, og Community Edition publiseres i overleaf/overleaf. En copybot er ansvarlig for å synkronisere kode mellom det interne og det offentlige repositoryet.
  • Ayaka-notes/overleaf-pro er en fork av Overleaf Community. Vi ønsker at dette prosjektet skal være langsiktig, så følg reglene før du bidrar.

Regler for commits

  • Ikke gjør omfattende endringer i den eksisterende Overleaf-koden. Samle så mye funksjonalitet som mulig i mappen services/web/modules. Dette minimerer arbeidsmengden vår når vi senere fletter og oppdaterer koden.
  • Vibe coding er riktignok svært enkelt, men det kan lett skape rot i prosjektet og gjøre det umulig å vedlikeholde senere, så bruk det med forsiktighet.
  • Gjenbruk eksisterende oversettelsesnøkler når det er mulig. Hvis en ny nøkkel virkelig trengs, legger du den til i services/web/locales/locales_patches/added/ for alle språk samtidig, se Oppdatere i18n-oversettelser.
  • Unngå å innføre miljøvariabler med mindre det er absolutt nødvendig. Hvis det er nødvendig, sørg for at de er så konsistente som mulig med dem i Overleaf Toolkit eller docs.overleaf.com.

Regler for brancher

Vi bruker følgende brancher for utvikling av overleaf-pro:
  • main: Denne branchen brukes kun til synkronisering av upstream-kode, så IKKE commit noen eksterne endringer. I denne branchen setter vi tagger som ce-v[X.x.x], som angir at den tilsvarer v[X.x.x] i den offisielle Overleaf Community Edition. Merk: denne taggen er uforanderlig!
  • server-pro: Denne branchen er standardbranchen for daglig utvikling.
  • feat-X: Denne branchen brukes til utvikling av en bestemt funksjon, for eksempel feat-gitea-sync.
  • release-vX.Y.Z: Branchen som er dedikert til utgivelser; vi gjør noen hotfikser før utgivelse. Patchutgivelser får også sin egen branch, for eksempel release-v6.3.1. Den utgitte commiten tagges pro-vX.Y.Z på denne branchen.

Regler for brancher i Overleaf Pro

GitHub Action

GitHub Action er ansvarlig for automatisk CI/CD. Du trenger ikke å bygge images på din egen maskin: hvert image nedenfor bygges av en workflow, og de som har manuell utløser, kan bygges med ett klikk.
  • Utviklingsimages inneholder én mikrotjeneste hver (web, webpack, clsi, …) for linux/amd64 og linux/arm64. Codespace-oppsettet henter dem via develop/docker-compose.image.yml i stedet for å kjøre bin/build.
  • Driftsimages er komplette images med én container (som sharelatex/sharelatex) for å teste en endring fra ende til ende. ops:latest flyttes bare ved push til server-pro; en PR får kun en tidsstemplet tag. Disse imagene beholdes i 7 dager og er kun ment for testing.
  • Utgivelsesimages er det brukerne deployer. Versjonen hentes fra branchnavnet, så release-v6.3.0 publiserer overleaf-pro:6.3.0.
1

Kjør en workflow manuelt

Åpne fanen Actions, velg workflowen til venstre, klikk Run workflow og bekreft. Build Operations Image har også et Build without cache-alternativ for tilfeller der et hurtigbufret lag er utdatert.
2

Bygg i din fork

De samme workflowene kjører i en fork: aktiver Actions i forken din, og kjør dem deretter fra Actions-fanen der. Images pushes til ghcr.io/<your-name>/overleaf-pro/... med den innebygde GITHUB_TOKEN, så ingen secrets er nødvendige. Sync Upstream Code og oppryddingen av gamle images kjører bare i ayaka-notes.Build Release Image krever en release-v*-branch i forken din.
Slik sjekker du hvilken commit et image ble bygget fra: taggen til et driftsimage slutter med den korte commit-hashen, og et utgivelsesimage har den i labelen com.overleaf.pro.revision (se docker inspect i spørsmål og svar nedenfor).

Spørsmål og svar

Først må du hente Docker-imaget og kjøre følgende kommando for å inspisere labels i dette Docker-imaget:
bash
Deretter kan du sjekke om commiten (b0d05c0) finnes i upstream master-branchen.
Dette er forventet oppførsel. Utgivelsen 6.0.1 er en mindre patch-utgivelse bygget på toppen av 6.0.0-imaget. Endringene påføres ved å patche det eksisterende 6.0.0-imaget, i stedet for å bygge imaget på nytt fra en ny commit. Derfor er commit-hashen inne i imaget identisk mellom 6.0.0 og 6.0.1.For detaljert informasjon, se hotfix.
Sist endret 20. november 2026