Introduktion
Innan du dyker in i utvecklingen hoppas vi att du förstår följande:- Overleaf utvecklas officiellt i ett internt repository, och community-utgåvan publiceras i overleaf/overleaf. En copybot ansvarar för att synkronisera kod mellan det interna och det publika repositoryt.
- Ayaka-notes/overleaf-pro är en fork av Overleaf Community. Vi hoppas att projektet ska bli långlivat, så följ reglerna innan du bidrar.
Regler för commits
- Gör inga omfattande ändringar i den befintliga Overleaf-koden. Samla så mycket funktionalitet som möjligt i mappen
services/web/modules. Det minimerar vårt arbete när vi senare slår ihop och uppdaterar koden. - Vibe coding är visserligen ett mycket enkelt arbetssätt, men det kan lätt röra till projektet och göra det svårt att underhålla senare, så använd det med försiktighet.
- Återanvänd befintliga översättningsnycklar när det är möjligt. Om en ny nyckel verkligen behövs lägger du till den i
services/web/locales/locales_patches/added/för alla språk på en gång, se Uppdatera i18n-översättningar. - Undvik att införa miljövariabler om det inte är absolut nödvändigt. Om det krävs, se till att de är så konsekventa som möjligt med dem i Overleaf Toolkit eller docs.overleaf.com.
Regler för grenar
Vi använder följande grenar för utvecklingen av overleaf-pro:main: Den här grenen används endast för synkronisering av upstream-kod, så committa INTE några externa ändringar. I den här grenen sätter vi taggar somce-v[X.x.x], vilket anger att den motsvararv[X.x.x]i Overleafs officiella Community Edition. Obs: den här taggen är oföränderlig!server-pro: Den här grenen är standardgrenen för den dagliga utvecklingen.feat-X: Den här grenen används för utveckling av en specifik funktion, till exempelfeat-gitea-sync.release-vX.Y.Z: Grenen som är specifik för en release; vi gör vissa snabbkorrigeringar (hot-fix) före releasen. Patchreleaser får också en egen gren, till exempelrelease-v6.3.1. Den släppta commiten taggaspro-vX.Y.Zpå den här grenen.

Grenregler för Overleaf Pro
GitHub Action
GitHub Action ansvarar för automatisk CI/CD. Du behöver inte bygga images på din egen dator: varje image nedan byggs av ett arbetsflöde, och de som har manuell utlösare kan byggas med ett klick.- Utvecklingsimages innehåller en mikrotjänst var (
web,webpack,clsi, …) förlinux/amd64ochlinux/arm64. Codespace-konfigurationen hämtar dem viadevelop/docker-compose.image.ymli stället för att körabin/build. - Driftimages är kompletta images med en enda container (som
sharelatex/sharelatex) för att testa en ändring från början till slut.ops:latestflyttas bara vid pushar tillserver-pro; en PR får endast en tidsstämplad tagg. Dessa images sparas i 7 dagar och är endast avsedda för testning. - Releaseimages är det som användare driftsätter. Versionen hämtas från grennamnet, så
release-v6.3.0publiceraroverleaf-pro:6.3.0.
1
Kör ett arbetsflöde manuellt
Öppna fliken Actions, välj arbetsflödet till vänster, klicka på Run workflow och bekräfta. Build Operations Image har även alternativet Build without cache för när ett cachat lager är inaktuellt.
2
Bygg i din fork
Samma arbetsflöden körs i en fork: aktivera Actions i din fork och kör dem sedan från dess Actions-flik. Images pushas till
ghcr.io/<your-name>/overleaf-pro/... med den inbyggda GITHUB_TOKEN, så inga hemligheter behövs. Sync Upstream Code och rensningen av gamla images körs endast i ayaka-notes.Build Release Image kräver en release-v*-gren i din fork.Så kontrollerar du vilken commit en image byggdes från: taggen för en driftimage slutar med den korta commit-hashen, och en releaseimage har den i etiketten
com.overleaf.pro.revision (se docker inspect i Frågor och svar nedan).Frågor och svar
Hur hittar jag commit-hashen för Overleaf Community Edition X.0.0?
Hur hittar jag commit-hashen för Overleaf Community Edition X.0.0?
Först behöver du hämta Docker-imagen och köra följande kommando för att inspektera etiketterna i den:Sedan kan du kontrollera om commit(b0d05c0) finns i upstreams master-gren.
bash
Varför är commit-hashen densamma i CE-imagen för 6.0.0 och 6.0.1?
Varför är commit-hashen densamma i CE-imagen för 6.0.0 och 6.0.1?
Detta är förväntat beteende. Version 6.0.1 är en mindre patch-release som bygger på 6.0.0-imagen. Ändringarna tillämpas genom att patcha den befintliga 6.0.0-imagen i stället för att bygga om imagen från en ny commit. Därför är commit-hashen i imagen identisk mellan 6.0.0 och 6.0.1.Mer information finns i hotfix.

