Přejít na hlavní obsah

Úvod

Než se pustíte do vývoje, doufáme, že porozumíte následujícím věcem:
  • Overleaf je oficiálně vyvíjen v interním repozitáři a komunitní edice je publikována v overleaf/overleaf. Za synchronizaci kódu mezi interním a veřejným repozitářem odpovídá copybot.
  • Ayaka-notes/overleaf-pro je fork komunitní verze Overleaf. Přejeme si, aby byl tento projekt dlouhodobý, proto prosím před přispěním dodržujte pravidla.

Pravidla pro commity

  • Neprovádějte prosím rozsáhlé úpravy stávajícího kódu Overleaf. Soustřeďte co nejvíce funkcionality do složky services/web/modules. Minimalizuje to naši práci při pozdějším slučování a aktualizaci kódu.
  • Vibe coding je sice velmi snadný přístup, ale může v projektu snadno nadělat nepořádek a později ho učinit neudržovatelným, proto jej používejte s rozvahou.
  • Kdykoli je to možné, používejte existující překladové klíče. Pokud je nový klíč opravdu potřeba, přidejte ho do services/web/locales/locales_patches/added/ pro všechny jazyky najednou, viz Aktualizace překladů i18n.
  • Nezavádějte proměnné prostředí, pokud to není nezbytně nutné. Pokud jsou nutné, zajistěte, aby byly co nejvíce konzistentní s proměnnými v Overleaf toolkitu nebo na docs.overleaf.com.

Pravidla pro větve

Pro vývoj overleaf-pro používáme následující větve:
  • main: Tato větev slouží pouze k synchronizaci kódu z upstreamu, prosím do ní NECOMMITUJTE žádné externí změny. V této větvi nastavujeme tagy jako ce-v[X.x.x], které označují, že odpovídá verzi v[X.x.x] oficiální komunitní edice Overleaf. Poznámka: tento tag je neměnný!
  • server-pro: Tato větev je výchozí větví pro každodenní vývoj.
  • feat-X: Tato větev slouží k vývoji konkrétní funkce, například feat-gitea-sync.
  • release-vX.Y.Z: Větev určená pro vydání, před vydáním v ní provádíme hotfixy. Opravná vydání mají také vlastní větev, například release-v6.3.1. Vydaný commit je na této větvi označen tagem pro-vX.Y.Z.

Pravidla pro větve v Overleaf Pro

GitHub Action

GitHub Action zajišťuje automatické CI/CD. Image nemusíte sestavovat na vlastním počítači: každý z níže uvedených image sestavuje workflow a ty s ručním spuštěním lze sestavit jedním kliknutím.
  • Vývojové image obsahují vždy jednu mikroslužbu (web, webpack, clsi, …) pro linux/amd64 a linux/arm64. Nastavení Codespace je stahuje přes develop/docker-compose.image.yml místo spouštění bin/build.
  • Provozní image jsou úplné jednokontejnerové image (jako sharelatex/sharelatex) pro komplexní otestování změny. ops:latest se posouvá jen při pushi do server-pro; PR dostane pouze tag s časovým razítkem. Tyto image se uchovávají 7 dní a slouží pouze k testování.
  • Vydávací image jsou to, co uživatelé nasazují. Verze se odvozuje z názvu větve, takže release-v6.3.0 publikuje overleaf-pro:6.3.0.
1

Ruční spuštění workflow

Otevřete záložku Actions, vlevo vyberte workflow, klikněte na Run workflow a potvrďte. Build Operations Image má navíc volbu Build without cache pro případ, kdy je vrstva v cache zastaralá.
2

Sestavení ve vašem forku

Stejná workflow běží i ve forku: povolte ve svém forku Actions a pak je spusťte z jeho záložky Actions. Image se pushují do ghcr.io/<your-name>/overleaf-pro/... pomocí vestavěného GITHUB_TOKEN, takže nejsou potřeba žádné secrets. Sync Upstream Code a čištění starých image běží pouze v ayaka-notes.Build Release Image vyžaduje ve vašem forku větev release-v*.
Jak zjistit, ze kterého commitu byl image sestaven: tag provozního image končí zkráceným hashem commitu a vydávací image jej nese v labelu com.overleaf.pro.revision (viz docker inspect v otázkách a odpovědích níže).

Otázky a odpovědi

Nejprve musíte stáhnout Docker image a spustit následující příkaz, který zobrazí štítky (labels) v tomto Docker image:
bash
Poté můžete ověřit, zda je commit (b0d05c0) přítomen ve větvi master v upstreamu.
Jde o očekávané chování. Vydání 6.0.1 je drobné opravné vydání postavené nad image 6.0.0. Změny jsou aplikovány záplatováním stávajícího image 6.0.0 místo nového sestavení image z nového commitu. Proto je hash commitu uvnitř image u verzí 6.0.0 a 6.0.1 totožný.Podrobné informace najdete v hotfix.
Naposledy změněno 20. listopadu 2026