Saltar para o conteúdo principal

Introdução

Antes de mergulhar no desenvolvimento, esperamos que você compreenda os seguintes pontos:
  • Oficialmente, o Overleaf é desenvolvido em um repositório interno, e a Community Edition é publicada em overleaf/overleaf. Um copybot é responsável por sincronizar o código entre os repositórios interno e público.
  • Ayaka-notes/overleaf-pro é uma versão derivada (fork) do Overleaf Community. Esperamos que este projeto seja de longo prazo, por isso, siga as regras antes de contribuir.

Regras de commit

  • Não faça modificações extensas no código existente do Overleaf. Concentre o máximo possível de funcionalidades na pasta services/web/modules. Isso minimizará nosso trabalho ao mesclar e atualizar o código posteriormente.
  • O vibe coding é de fato muito prático, mas pode facilmente bagunçar nosso projeto, tornando-o impossível de manter mais tarde; por isso, use-o com cautela.
  • Reutilize as chaves de tradução existentes sempre que possível. Se uma nova chave for realmente necessária, adicione-a em services/web/locales/locales_patches/added/ para todos os idiomas de uma só vez; consulte Atualizar traduções i18n.
  • Evite introduzir variáveis de ambiente, a menos que seja absolutamente necessário. Se forem necessárias, garanta que sejam o mais consistentes possível com as do Overleaf Toolkit ou de docs.overleaf.com.

Regras de branches

Usamos os seguintes branches para o desenvolvimento do overleaf-pro:
  • main: Este branch é usado apenas para a sincronização do código upstream; NÃO faça commit de nenhuma alteração externa. Neste branch, definimos algumas tags como ce-v[X.x.x], que indicam a correspondência com a v[X.x.x] do Overleaf Community Edition oficial. Observação: essa tag é imutável!
  • server-pro: Este é o branch padrão para o desenvolvimento diário.
  • feat-X: Este branch é usado para desenvolver uma funcionalidade específica, por exemplo feat-gitea-sync.
  • release-vX.Y.Z: Branch específico para lançamentos; faremos alguns hot-fixes antes do lançamento. Versões de patch também têm seu próprio branch, por exemplo release-v6.3.1. O commit lançado recebe a tag pro-vX.Y.Z neste branch.

Regras de branches do Overleaf Pro

GitHub Action

O GitHub Action é responsável pelo CI/CD automático. Você não precisa gerar imagens na sua própria máquina: todas as imagens abaixo são geradas por um workflow, e as que têm acionamento manual podem ser geradas com um clique.
  • Imagens de desenvolvimento contêm um microsserviço cada (web, webpack, clsi, …) para linux/amd64 e linux/arm64. A configuração do Codespace as baixa por meio de develop/docker-compose.image.yml em vez de executar bin/build.
  • Imagens de operações são imagens completas de contêiner único (como sharelatex/sharelatex) para testar uma alteração de ponta a ponta. ops:latest só é atualizada em pushes para server-pro; um PR recebe apenas uma tag com carimbo de data/hora. Essas imagens são mantidas por 7 dias e servem apenas para testes.
  • Imagens de release são as que os usuários implantam. A versão vem do nome do branch, então release-v6.3.0 publica overleaf-pro:6.3.0.
1

Executar um workflow manualmente

Abra a aba Actions, escolha o workflow à esquerda, clique em Run workflow e confirme. O Build Operations Image também tem a opção Build without cache para quando uma camada em cache estiver desatualizada.
2

Gerar no seu fork

Os mesmos workflows funcionam em um fork: ative o Actions no seu fork e execute-os pela aba Actions dele. As imagens são enviadas para ghcr.io/<your-name>/overleaf-pro/... com o GITHUB_TOKEN integrado, então nenhum segredo é necessário. O Sync Upstream Code e a limpeza de imagens antigas só são executados em ayaka-notes.O Build Release Image precisa de um branch release-v* no seu fork.
Para verificar a partir de qual commit uma imagem foi gerada: a tag de uma imagem de operações termina com o hash curto do commit, e uma imagem de release o traz no label com.overleaf.pro.revision (veja docker inspect nas Perguntas e respostas abaixo).

Perguntas e respostas

Primeiro, você precisa baixar a imagem Docker e executar o seguinte comando para inspecionar os labels dessa imagem:
bash
Em seguida, você pode verificar se o commit (b0d05c0) está presente no branch master upstream.
Esse é um comportamento esperado. A versão 6.0.1 é uma pequena versão de patch construída sobre a imagem 6.0.0. As alterações são aplicadas por meio de patches na imagem 6.0.0 existente, em vez de reconstruir a imagem a partir de um novo commit. Por isso, o hash do commit dentro da imagem é idêntico entre 6.0.0 e 6.0.1.Para informações detalhadas, consulte hotfix.
Última modificação em 20 de novembro de 2026