Введение
Прежде чем приступить к разработке, просим вас ознакомиться со следующим:- Официально 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: эта ветка используется только для синхронизации с апстримом, пожалуйста, НЕ коммитьте в неё никаких сторонних изменений. В этой ветке мы ставим теги вида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-образ и выполнить следующую команду, чтобы просмотреть метки этого образа:Затем можно проверить, присутствует ли коммит (b0d05c0) в ветке master апстрима.
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.

