Вступ
Перш ніж заглиблюватися в розробку, просимо вас ознайомитися з таким:- Офіційно Overleaf розробляється у внутрішньому репозиторії, а версія Community Edition публікується в overleaf/overleaf. За синхронізацію коду між внутрішнім і публічним репозиторіями відповідає copybot.
- Ayaka-notes/overleaf-pro — це форк Overleaf Community. Ми хочемо, щоб цей проєкт був довготривалим, тому, будь ласка, дотримуйтеся правил, перш ніж робити внесок.
Правила комітів
- Будь ласка, не вносьте масштабних змін в наявний код Overleaf. Зосереджуйте якомога більше функціональності в теці
services/web/modules. Це мінімізує наші зусилля під час подальшого злиття й оновлення коду. - Vibe coding — справді дуже простий спосіб, але він легко може внести безлад у проєкт і згодом зробити його непідтримуваним, тож використовуйте його обережно.
- За можливості повторно використовуйте наявні ключі перекладів. Якщо новий ключ справді потрібен, додайте його до
services/web/locales/locales_patches/added/одразу для всіх мов, див. Оновлення перекладів i18n. - Уникайте додавання змінних середовища без крайньої потреби. Якщо вони все ж потрібні, переконайтеся, що вони максимально узгоджені зі змінними в Overleaf Toolkit або на docs.overleaf.com.
Правила гілок
Для розробки overleaf-pro ми використовуємо такі гілки:main: ця гілка використовується лише для синхронізації коду з upstream, будь ласка, НЕ комітьте до неї жодних сторонніх змін. У цій гілці ми ставимо теги на кшталтce-v[X.x.x], які означають, що стан відповідаєv[X.x.x]в офіційній Overleaf Community Edition. Примітка: цей тег незмінний!server-pro: гілка за замовчуванням для щоденної розробки.feat-X: гілка для розробки конкретної функції, наприкладfeat-gitea-sync.release-vX.Y.Z: гілка, призначена для релізу; перед релізом ми вносимо в неї гарячі виправлення. Патч-релізи також отримують власну гілку, наприкладrelease-v6.3.1. Випущений коміт позначається в цій гілці тегомpro-vX.Y.Z.

Правила гілок для Overleaf Pro
GitHub Action
GitHub Action відповідає за автоматичний CI/CD. Вам не потрібно збирати образи на власній машині: кожен образ нижче збирається workflow, а ті, що мають ручний запуск, можна зібрати одним кліком.- Образи для розробки містять по одному мікросервісу (
web,webpack,clsi, …) дляlinux/amd64іlinux/arm64. Налаштування Codespace завантажує їх черезdevelop/docker-compose.image.ymlзамість запускуbin/build. - Операційні образи — це повні одноконтейнерні образи (як-от
sharelatex/sharelatex) для наскрізного тестування змін.ops:latestоновлюється лише під час push доserver-pro; PR отримує лише тег із часовою позначкою. Ці образи зберігаються 7 днів і призначені лише для тестування. - Релізні образи — це те, що розгортають користувачі. Версія береться з назви гілки, тож
release-v6.3.0публікуєoverleaf-pro:6.3.0.
1
Запуск workflow вручну
Відкрийте вкладку Actions, виберіть workflow ліворуч, натисніть Run workflow і підтвердьте. Build Operations Image також має параметр Build without cache для випадків, коли кешований шар застарів.
2
Збирання у вашому форку
Ті самі workflow працюють і у форку: увімкніть Actions у своєму форку, а потім запускайте їх із його вкладки Actions. Образи надсилаються до
ghcr.io/<your-name>/overleaf-pro/... за допомогою вбудованого GITHUB_TOKEN, тож секрети не потрібні. Sync Upstream Code і очищення старих образів запускаються лише в ayaka-notes.Для Build Release Image потрібна гілка release-v* у вашому форку.Щоб перевірити, з якого коміту зібрано образ: тег операційного образу закінчується коротким хешем коміту, а релізний образ містить його в мітці
com.overleaf.pro.revision (див. docker inspect у розділі «Питання та відповіді» нижче).Питання та відповіді
Як знайти хеш коміту для Overleaf Community Edition X.0.0?
Як знайти хеш коміту для Overleaf Community Edition X.0.0?
Насамперед потрібно завантажити Docker-образ і виконати таку команду, щоб переглянути мітки (labels) цього образу:Потім можна перевірити, чи присутній коміт (b0d05c0) у гілці master в upstream.
bash
Чому хеш коміту однаковий в образах CE 6.0.0 і 6.0.1?
Чому хеш коміту однаковий в образах CE 6.0.0 і 6.0.1?
Це очікувана поведінка. Реліз 6.0.1 — це невеликий патч-реліз, зібраний на основі образу 6.0.0. Зміни застосовуються шляхом патчування наявного образу 6.0.0, а не повторного збирання образу з нового коміту. Тому хеш коміту всередині образу однаковий для 6.0.0 і 6.0.1.Докладніше див. hotfix.

