Introduktion
Før du kaster dig ud i udviklingen, håber vi, at du vil sætte dig ind i følgende:- Overleaf udvikles officielt i et internt repository, og community-udgaven udgives i overleaf/overleaf. En copybot står for at synkronisere koden mellem det interne og det offentlige repository.
- Ayaka-notes/overleaf-pro er en fork af Overleaf Community. Vi håber, at dette projekt kan blive langvarigt, så følg venligst reglerne, før du bidrager.
Regler for commits
- Undlad at foretage omfattende ændringer i den eksisterende Overleaf-kode. Saml så meget funktionalitet som muligt i mappen
services/web/modules. Det minimerer vores arbejde, når koden senere skal merges og opdateres. - Vibe coding er ganske vist en meget nem metode, men det kan nemt skabe rod i projektet og gøre det uvedligeholdeligt senere, så brug det med forsigtighed.
- Genbrug så vidt muligt eksisterende oversættelsesnøgler. Hvis en ny nøgle virkelig er nødvendig, så tilføj den i
services/web/locales/locales_patches/added/for alle sprog på én gang, se Opdater i18n-oversættelser. - Undgå at indføre miljøvariabler, medmindre det er absolut nødvendigt. Hvis det er påkrævet, så sørg for, at de er så konsistente som muligt med dem i Overleaf Toolkit eller docs.overleaf.com.
Regler for branches
Vi bruger følgende branches til udvikling af overleaf-pro:main: Denne branch bruges kun til synkronisering af upstream-kode, så commit IKKE eksterne ændringer hertil. I denne branch sætter vi tags somce-v[X.x.x], der angiver, at den svarer tilv[X.x.x]i den officielle Overleaf Community Edition. Bemærk: disse tags er uforanderlige!server-pro: Denne branch er standardbranchen til den daglige udvikling.feat-X: Denne branch bruges til udvikling af en bestemt funktion, for eksempelfeat-gitea-sync.release-vX.Y.Z: Branchen dedikeret til en udgivelse; her laver vi eventuelle hotfixes før udgivelsen. Patchudgivelser får også deres egen branch, for eksempelrelease-v6.3.1. Det udgivne commit taggespro-vX.Y.Zpå denne branch.

Regler for branches i Overleaf Pro
GitHub Action
GitHub Action står for automatisk CI/CD. Du behøver ikke at bygge images på din egen maskine: hvert image nedenfor bygges af et workflow, og dem med manuel udløser kan bygges med ét klik.- Udviklings-images indeholder hver én microservice (
web,webpack,clsi, …) tillinux/amd64oglinux/arm64. Codespace-opsætningen henter dem viadevelop/docker-compose.image.ymli stedet for at kørebin/build. - Drifts-images er komplette single-container-images (ligesom
sharelatex/sharelatex) til at teste en ændring fra ende til anden.ops:latestflyttes kun ved pushes tilserver-pro; en PR får kun et tag med tidsstempel. Disse images opbevares i 7 dage og er kun til test. - Release-images er dem, brugerne deployer. Versionen kommer fra branchnavnet, så
release-v6.3.0udgiveroverleaf-pro:6.3.0.
1
Kør et workflow manuelt
Åbn fanen Actions, vælg workflowet til venstre, klik på Run workflow, og bekræft. Build Operations Image har også en Build without cache-indstilling til når et cachet lag er forældet.
2
Byg i din fork
De samme workflows kører i en fork: aktivér Actions i din fork, og kør dem derefter fra dens Actions-fane. Images pushes til
ghcr.io/<your-name>/overleaf-pro/... med den indbyggede GITHUB_TOKEN, så der kræves ingen secrets. Sync Upstream Code og oprydningen af gamle images kører kun i ayaka-notes.Build Release Image kræver en release-v*-branch i din fork.Sådan tjekker du, hvilket commit et image blev bygget fra: et drifts-images tag slutter med den korte commit-hash, og et release-image har den i labelen
com.overleaf.pro.revision (se docker inspect i spørgsmål og svar nedenfor).Spørgsmål og svar
Hvordan finder jeg commit-hashen for Overleaf Community Edition X.0.0?
Hvordan finder jeg commit-hashen for Overleaf Community Edition X.0.0?
Først skal du hente Docker-imaget og køre følgende kommando for at inspicere labels i Docker-imaget:Derefter kan du kontrollere, om committet (b0d05c0) findes i upstreams master-branch.
bash
Hvorfor er commit-hashen den samme i CE-imaget for 6.0.0 og 6.0.1?
Hvorfor er commit-hashen den samme i CE-imaget for 6.0.0 og 6.0.1?
Dette er forventet adfærd. Udgivelse 6.0.1 er en mindre patch-udgivelse bygget oven på 6.0.0-imaget. Ændringerne anvendes ved at patche det eksisterende 6.0.0-image i stedet for at genopbygge imaget fra et nyt commit. Derfor er commit-hashen i imaget identisk mellem 6.0.0 og 6.0.1.Se hotfix for detaljerede oplysninger.

