Wprowadzenie
Zanim zagłębisz się w rozwój projektu, prosimy o zapoznanie się z następującymi kwestiami:- Overleaf jest oficjalnie rozwijany w wewnętrznym repozytorium, a wersja społecznościowa (Community Edition) jest publikowana w overleaf/overleaf. Za synchronizację kodu między repozytorium wewnętrznym a publicznym odpowiada copybot.
- Ayaka-notes/overleaf-pro to fork wersji społecznościowej Overleaf. Chcemy, aby ten projekt był rozwijany długoterminowo, dlatego przed wniesieniem wkładu prosimy o przestrzeganie poniższych zasad.
Zasady dotyczące commitów
- Prosimy nie wprowadzać rozległych modyfikacji w istniejącym kodzie Overleaf. Skupiaj jak najwięcej funkcjonalności w katalogu
services/web/modules. Zminimalizuje to nakład pracy przy późniejszym scalaniu i aktualizowaniu kodu. - Vibe coding to rzeczywiście bardzo wygodna metoda, ale łatwo może wprowadzić bałagan w projekcie i sprawić, że później stanie się on trudny w utrzymaniu, dlatego korzystaj z niego ostrożnie.
- W miarę możliwości używaj ponownie istniejących kluczy tłumaczeń. Jeśli nowy klucz jest naprawdę potrzebny, dodaj go do
services/web/locales/locales_patches/added/od razu dla wszystkich języków, zobacz Aktualizacja tłumaczeń i18n. - Unikaj wprowadzania zmiennych środowiskowych, o ile nie jest to absolutnie konieczne. Jeśli są wymagane, zadbaj o to, aby były jak najbardziej spójne z tymi z Overleaf Toolkit lub docs.overleaf.com.
Zasady dotyczące gałęzi
Do rozwoju overleaf-pro używamy następujących gałęzi:main: Ta gałąź służy wyłącznie do synchronizacji kodu z upstreamu, prosimy NIE commitować do niej żadnych zewnętrznych zmian. W tej gałęzi ustawiamy tagi takie jakce-v[X.x.x], które oznaczają, że dany stan odpowiada wersjiv[X.x.x]oficjalnej wersji Overleaf Community Edition. Uwaga: te tagi są niezmienne!server-pro: Domyślna gałąź do codziennego rozwoju.feat-X: Gałąź służąca do rozwoju konkretnej funkcji, na przykładfeat-gitea-sync.release-vX.Y.Z: Gałąź przeznaczona dla wydania; przed wydaniem wprowadzamy w niej poprawki typu hot-fix. Wydania poprawkowe również dostają własną gałąź, na przykładrelease-v6.3.1. Wydany commit jest oznaczany na tej gałęzi tagiempro-vX.Y.Z.

Zasady dotyczące gałęzi w Overleaf Pro
GitHub Action
GitHub Action odpowiada za automatyczne CI/CD. Nie musisz budować obrazów na własnym komputerze: każdy z poniższych obrazów jest budowany przez workflow, a te z ręcznym wyzwalaczem można zbudować jednym kliknięciem.- Obrazy deweloperskie zawierają po jednej mikrousłudze (
web,webpack,clsi, …) dlalinux/amd64ilinux/arm64. Konfiguracja Codespace pobiera je za pomocądevelop/docker-compose.image.ymlzamiast uruchamiaćbin/build. - Obrazy operacyjne to pełne obrazy jednokontenerowe (jak
sharelatex/sharelatex) służące do kompleksowego testowania zmian.ops:latestjest przesuwany tylko przy pushach doserver-pro; PR otrzymuje wyłącznie tag z sygnaturą czasową. Obrazy te są przechowywane przez 7 dni i służą wyłącznie do testów. - Obrazy wydań to obrazy wdrażane przez użytkowników. Wersja pochodzi z nazwy gałęzi, więc
release-v6.3.0publikujeoverleaf-pro:6.3.0.
1
Ręczne uruchamianie workflow
Otwórz kartę Actions, wybierz workflow po lewej stronie, kliknij Run workflow i potwierdź. Build Operations Image ma również opcję Build without cache na wypadek, gdy warstwa w pamięci podręcznej jest nieaktualna.
2
Budowanie we własnym forku
Te same workflow działają w forku: włącz Actions w swoim forku, a następnie uruchamiaj je z jego karty Actions. Obrazy są wypychane do
ghcr.io/<your-name>/overleaf-pro/... za pomocą wbudowanego GITHUB_TOKEN, więc żadne sekrety nie są potrzebne. Sync Upstream Code oraz czyszczenie starych obrazów działają tylko w ayaka-notes.Build Release Image wymaga gałęzi release-v* w Twoim forku.Aby sprawdzić, z którego commitu zbudowano obraz: tag obrazu operacyjnego kończy się skróconym hashem commitu, a obraz wydania zawiera go w etykiecie
com.overleaf.pro.revision (zobacz docker inspect w sekcji Pytania i odpowiedzi poniżej).Pytania i odpowiedzi
Jak znaleźć hash commitu dla Overleaf Community Edition X.0.0?
Jak znaleźć hash commitu dla Overleaf Community Edition X.0.0?
Najpierw pobierz obraz Docker i uruchom poniższe polecenie, aby sprawdzić etykiety tego obrazu:Następnie możesz sprawdzić, czy commit (b0d05c0) znajduje się w gałęzi master upstreamu.
bash
Dlaczego hash commitu w obrazie CE jest taki sam dla wersji 6.0.0 i 6.0.1?
Dlaczego hash commitu w obrazie CE jest taki sam dla wersji 6.0.0 i 6.0.1?
To zamierzone zachowanie. Wydanie 6.0.1 jest drobnym wydaniem poprawkowym zbudowanym na bazie obrazu 6.0.0. Zmiany są nakładane poprzez łatanie istniejącego obrazu 6.0.0, a nie przez przebudowanie obrazu z nowego commitu. Dlatego hash commitu wewnątrz obrazu jest identyczny w wersjach 6.0.0 i 6.0.1.Szczegółowe informacje znajdziesz w hotfix.

