Siirry pääsisältöön

Johdanto

Ennen kuin syvennyt kehitykseen, toivomme, että ymmärrät seuraavat asiat:
  • Overleafia kehitetään virallisesti sisäisessä repositoriossa, ja yhteisöversio julkaistaan repositoriossa overleaf/overleaf. Copybot huolehtii koodin synkronoinnista sisäisen ja julkisen repositorion välillä.
  • Ayaka-notes/overleaf-pro on Overleafin yhteisöversiosta haarautettu versio. Toivomme, että projekti on pitkäikäinen, joten noudata sääntöjä ennen kuin osallistut kehitykseen.

Commit-säännöt

  • Älä tee laajoja muutoksia olemassa olevaan Overleaf-koodiin. Keskitä mahdollisimman paljon toiminnallisuutta kansioon services/web/modules. Tämä minimoi työmäärämme, kun koodia myöhemmin yhdistetään ja päivitetään.
  • Vibe coding on toki hyvin helppo tapa, mutta se voi helposti sotkea projektimme ja tehdä siitä myöhemmin vaikeasti ylläpidettävän, joten käytä sitä varoen.
  • Käytä olemassa olevia käännösavaimia uudelleen aina kun mahdollista. Jos uusi avain on todella tarpeen, lisää se kaikille kielille kerralla hakemistoon services/web/locales/locales_patches/added/, katso i18n-käännösten päivittäminen.
  • Vältä uusien ympäristömuuttujien lisäämistä, ellei se ole ehdottoman välttämätöntä. Jos niitä tarvitaan, varmista, että ne ovat mahdollisimman yhdenmukaisia Overleaf Toolkitin tai docs.overleaf.com-sivuston muuttujien kanssa.

Haarasäännöt

Käytämme overleaf-pro-kehityksessä seuraavia haaroja:
  • main: Tätä haaraa käytetään vain upstream-koodin synkronointiin, joten ÄLÄ tee siihen mitään ulkopuolisia muutoksia. Tähän haaraan asetamme tageja, kuten ce-v[X.x.x], jotka osoittavat, että kyseinen kohta vastaa Overleafin virallisen yhteisöversion versiota v[X.x.x]. Huomio: tämä tagi on muuttumaton!
  • server-pro: Tämä haara on päivittäisen kehityksen oletushaara.
  • feat-X: Tätä haaraa käytetään tietyn ominaisuuden kehittämiseen, esimerkiksi feat-gitea-sync.
  • release-vX.Y.Z: Julkaisua varten tarkoitettu haara, johon teemme tarvittaessa pikakorjauksia ennen julkaisua. Myös korjausjulkaisut saavat oman haaransa, esimerkiksi release-v6.3.1. Julkaistu commit merkitään tässä haarassa tagilla pro-vX.Y.Z.

Overleaf Pron haarasäännöt

GitHub Action

GitHub Action vastaa automaattisesta CI/CD:stä. Sinun ei tarvitse koostaa imageja omalla koneellasi: jokainen alla oleva image koostetaan työnkulussa, ja ne, joilla on manuaalinen käynnistin, voidaan koostaa yhdellä napsautuksella.
  • Kehitysimaget sisältävät kukin yhden mikropalvelun (web, webpack, clsi, …) arkkitehtuureille linux/amd64 ja linux/arm64. Codespace-ympäristö hakee ne tiedoston develop/docker-compose.image.yml kautta sen sijaan, että suorittaisi komennon bin/build.
  • Operations-imaget ovat täydellisiä yhden kontin imageja (kuten sharelatex/sharelatex), joilla muutosta voi testata kokonaisuutena. ops:latest siirtyy vain pushattaessa haaraan server-pro; PR saa vain aikaleimatun tagin. Näitä imageja säilytetään 7 päivää, ja ne on tarkoitettu vain testaukseen.
  • Julkaisuimaget ovat niitä, joita käyttäjät ottavat käyttöön. Versio määräytyy haaran nimestä, joten release-v6.3.0 julkaisee imagen overleaf-pro:6.3.0.
1

Työnkulun suorittaminen manuaalisesti

Avaa Actions-välilehti, valitse työnkulku vasemmalta, napsauta Run workflow ja vahvista. Build Operations Image -työnkulussa on myös Build without cache -vaihtoehto tilanteisiin, joissa välimuistissa oleva kerros on vanhentunut.
2

Koostaminen omassa forkissa

Samat työnkulut toimivat forkissa: ota Actions käyttöön forkissasi ja suorita ne sen Actions-välilehdeltä. Imaget pushataan osoitteeseen ghcr.io/<your-name>/overleaf-pro/... sisäänrakennetulla GITHUB_TOKEN-tunnuksella, joten salaisuuksia ei tarvita. Sync Upstream Code ja vanhojen imagejen siivous suoritetaan vain ayaka-notes-organisaatiossa.Build Release Image vaatii forkissasi release-v*-haaran.
Näin tarkistat, mistä commitista image on koostettu: operations-imagen tagi päättyy lyhyeen commit-tunnisteeseen, ja julkaisuimage sisältää sen com.overleaf.pro.revision-labelissa (katso docker inspect alla olevista kysymyksistä ja vastauksista).

Kysymyksiä ja vastauksia

Ensin sinun on haettava Docker-image ja suoritettava seuraava komento, jolla voit tarkastella imagen labeleita:
bash
Sen jälkeen voit tarkistaa, löytyykö commit (b0d05c0) upstreamin master-haarasta.
Tämä on odotettu toiminta. Versio 6.0.1 on pieni korjausjulkaisu, joka on rakennettu 6.0.0-imagen päälle. Muutokset on tehty paikkaamalla olemassa olevaa 6.0.0-imagea sen sijaan, että image olisi koostettu uudelleen uudesta commitista. Siksi imagen sisällä oleva commit-tunniste on sama versioissa 6.0.0 ja 6.0.1.Lisätietoja on kohdassa hotfix.
Viimeksi muokattu 20. marraskuuta 2026