Introducción
Antes de sumergirte en el desarrollo, esperamos que comprendas lo siguiente:- Overleaf se desarrolla oficialmente en un repositorio interno, y la edición comunitaria se publica en overleaf/overleaf. Un copybot se encarga de sincronizar el código entre el repositorio interno y el público.
- Ayaka-notes/overleaf-pro es una versión bifurcada (fork) de Overleaf Community. Queremos que este proyecto sea sostenible a largo plazo, así que sigue estas reglas antes de contribuir.
Reglas de commits
- No realices modificaciones extensas en el código existente de Overleaf. Concentra tanta funcionalidad como sea posible en la carpeta
services/web/modules. Así minimizaremos el trabajo al fusionar y actualizar el código más adelante. - El vibe coding es realmente una forma muy sencilla de trabajar, pero puede desordenar fácilmente nuestro proyecto y hacerlo inmantenible más adelante, así que úsalo con precaución.
- Reutiliza las claves de traducción existentes siempre que sea posible. Si realmente necesitas una clave nueva, añádela en
services/web/locales/locales_patches/added/para todos los idiomas a la vez; consulta Actualizar las traducciones i18n. - Evita introducir variables de entorno salvo que sea absolutamente necesario. Si son necesarias, asegúrate de que sean lo más coherentes posible con las del Overleaf Toolkit o de docs.overleaf.com.
Reglas de ramas
Usamos las siguientes ramas para el desarrollo de overleaf-pro:main: esta rama se usa solo para sincronizar el código upstream; NO hagas commit de ningún cambio externo. En esta rama crearemos etiquetas comoce-v[X.x.x], que indican que corresponde av[X.x.x]de la Community Edition oficial de Overleaf. Nota: ¡esta etiqueta es inmutable!server-pro: esta es la rama predeterminada para el desarrollo diario.feat-X: esta rama se usa para desarrollar una funcionalidad específica, por ejemplofeat-gitea-sync.release-vX.Y.Z: rama específica para una versión; en ella aplicaremos algunas correcciones urgentes (hot-fix) antes del lanzamiento. Las versiones de parche también tienen su propia rama, por ejemplorelease-v6.3.1. El commit publicado se etiqueta comopro-vX.Y.Zen esta rama.

Reglas de ramas para Overleaf Pro
GitHub Action
GitHub Action se encarga del CI/CD automático. No necesitas compilar imágenes en tu propia máquina: cada una de las imágenes siguientes se compila mediante un workflow, y las que tienen activación manual se pueden compilar con un solo clic.- Las imágenes de desarrollo contienen cada una un microservicio (
web,webpack,clsi, …) paralinux/amd64ylinux/arm64. La configuración de Codespace las descarga mediantedevelop/docker-compose.image.ymlen lugar de ejecutarbin/build. - Las imágenes de operaciones son imágenes completas de un solo contenedor (como
sharelatex/sharelatex) para probar un cambio de principio a fin.ops:latestsolo se actualiza con pushes aserver-pro; un PR solo recibe una etiqueta con marca de tiempo. Estas imágenes se conservan durante 7 días y son solo para pruebas. - Las imágenes de versión son las que despliegan los usuarios. La versión se obtiene del nombre de la rama, así que
release-v6.3.0publicaoverleaf-pro:6.3.0.
1
Ejecutar un workflow manualmente
Abre la pestaña Actions, elige el workflow a la izquierda, haz clic en Run workflow y confirma. Build Operations Image también tiene una opción Build without cache para cuando una capa en caché está obsoleta.
2
Compilar en tu fork
Los mismos workflows se ejecutan en un fork: habilita Actions en tu fork y ejecútalos desde su pestaña Actions. Las imágenes se publican en
ghcr.io/<your-name>/overleaf-pro/... con el GITHUB_TOKEN integrado, así que no se necesitan secretos. Sync Upstream Code y la limpieza de imágenes antiguas solo se ejecutan en ayaka-notes.Build Release Image necesita una rama release-v* en tu fork.Para comprobar a partir de qué commit se compiló una imagen: la etiqueta de una imagen de operaciones termina con el hash corto del commit, y una imagen de versión lo lleva en la etiqueta
com.overleaf.pro.revision (consulta docker inspect en las preguntas y respuestas más abajo).Preguntas y respuestas
¿Cómo encontrar el hash del commit de Overleaf Community Edition X.0.0?
¿Cómo encontrar el hash del commit de Overleaf Community Edition X.0.0?
En primer lugar, descarga la imagen de Docker y ejecuta el siguiente comando para inspeccionar las etiquetas de esa imagen:Después puedes comprobar si el commit (b0d05c0) está presente en la rama master upstream.
bash
¿Por qué el hash del commit es el mismo en la imagen CE entre 6.0.0 y 6.0.1?
¿Por qué el hash del commit es el mismo en la imagen CE entre 6.0.0 y 6.0.1?
Este es el comportamiento esperado. La versión 6.0.1 es un parche menor construido sobre la imagen 6.0.0. Los cambios se aplican parcheando la imagen 6.0.0 existente, en lugar de reconstruir la imagen a partir de un nuevo commit. Por lo tanto, el hash del commit dentro de la imagen es idéntico entre 6.0.0 y 6.0.1.Para más información, consulta hotfix.

