Pendahuluan
Sebelum Anda mulai melakukan pengembangan, kami berharap Anda memahami hal-hal berikut:- Overleaf secara resmi dikembangkan di repositori internal, dan edisi komunitasnya dipublikasikan di overleaf/overleaf. Sebuah copybot bertugas menyinkronkan kode antara repositori internal dan publik.
- Ayaka-notes/overleaf-pro adalah versi fork dari Overleaf komunitas. Kami berharap proyek ini dapat bertahan dalam jangka panjang, jadi harap ikuti aturan berikut sebelum berkontribusi.
Aturan Commit
- Harap jangan melakukan modifikasi besar-besaran pada kode Overleaf yang sudah ada. Pusatkan fungsionalitas sebanyak mungkin di folder
services/web/modules. Hal ini akan meminimalkan beban kerja kami saat menggabungkan dan memperbarui kode di kemudian hari. - Vibe coding memang cara yang sangat mudah, tetapi dapat dengan mudah membuat proyek kita berantakan sehingga sulit dipelihara di kemudian hari, jadi gunakanlah dengan hati-hati.
- Gunakan kembali kunci terjemahan yang sudah ada bila memungkinkan. Jika kunci baru benar-benar diperlukan, tambahkan ke
services/web/locales/locales_patches/added/untuk semua bahasa sekaligus, lihat Memperbarui Terjemahan i18n. - Hindari menambahkan variabel lingkungan kecuali benar-benar diperlukan. Jika memang diperlukan, pastikan variabel tersebut sekonsisten mungkin dengan yang ada di Overleaf toolkit atau docs.overleaf.com.
Aturan Branch
Kami menggunakan branch berikut untuk pengembangan overleaf-pro:main: Branch ini hanya digunakan untuk sinkronisasi kode upstream, harap JANGAN melakukan commit perubahan eksternal apa pun. Di branch ini, kami akan menetapkan beberapa tag sepertice-v[X.x.x], yang menandakan bahwa tag tersebut sesuai denganv[X.x.x]di Overleaf Official Community Edition. Catatan: tag ini tidak dapat diubah!server-pro: Branch ini adalah branch default untuk pengembangan sehari-hari.feat-X: Branch ini digunakan untuk mengembangkan fitur tertentu, misalnyafeat-gitea-sync.release-vX.Y.Z: Branch khusus untuk rilis; kami akan melakukan beberapa hot-fix sebelum rilis. Rilis patch juga mendapat branch sendiri, misalnyarelease-v6.3.1. Commit yang dirilis diberi tagpro-vX.Y.Zdi branch ini.

Aturan Branch untuk Overleaf Pro
GitHub Action
GitHub Action bertanggung jawab atas CI/CD otomatis. Anda tidak perlu membangun image di mesin Anda sendiri: setiap image di bawah ini dibangun oleh sebuah workflow, dan yang memiliki pemicu manual dapat dibangun dengan satu klik.- Image pengembangan masing-masing berisi satu microservice (
web,webpack,clsi, …) untuklinux/amd64danlinux/arm64. Penyiapan Codespace menarik image tersebut melaluidevelop/docker-compose.image.ymlalih-alih menjalankanbin/build. - Image operasional adalah image kontainer tunggal lengkap (seperti
sharelatex/sharelatex) untuk menguji perubahan secara menyeluruh.ops:latesthanya diperbarui saat ada push keserver-pro; PR hanya mendapatkan tag bertanda waktu. Image ini disimpan selama 7 hari dan hanya untuk pengujian. - Image rilis adalah yang di-deploy oleh pengguna. Versinya berasal dari nama branch, sehingga
release-v6.3.0menerbitkanoverleaf-pro:6.3.0.
1
Menjalankan Workflow Secara Manual
Buka tab Actions, pilih workflow di sebelah kiri, klik Run workflow, lalu konfirmasi. Build Operations Image juga memiliki opsi Build without cache untuk saat layer cache sudah usang.
2
Membangun di Fork Anda
Workflow yang sama berjalan di fork: aktifkan Actions di fork Anda, lalu jalankan dari tab Actions-nya. Image di-push ke
ghcr.io/<your-name>/overleaf-pro/... dengan GITHUB_TOKEN bawaan, sehingga tidak diperlukan secret apa pun. Sync Upstream Code dan pembersihan image lama hanya berjalan di ayaka-notes.Build Release Image memerlukan branch release-v* di fork Anda.Untuk memeriksa dari commit mana sebuah image dibangun: tag image operasional diakhiri dengan hash commit singkat, dan image rilis menyimpannya di label
com.overleaf.pro.revision (lihat docker inspect di Tanya Jawab di bawah).Tanya Jawab
Bagaimana cara menemukan commit hash untuk Overleaf Community Edition X.0.0?
Bagaimana cara menemukan commit hash untuk Overleaf Community Edition X.0.0?
Pertama-tama, Anda perlu menarik (pull) image docker dan menjalankan perintah berikut untuk memeriksa label pada image docker tersebut:Kemudian Anda dapat memeriksa apakah commit(b0d05c0) ada di branch master upstream.
bash
Mengapa commit hash pada image CE sama antara 6.0.0 dan 6.0.1?
Mengapa commit hash pada image CE sama antara 6.0.0 dan 6.0.1?
Ini adalah perilaku yang diharapkan. Rilis 6.0.1 adalah rilis patch minor yang dibangun di atas image 6.0.0. Perubahannya diterapkan dengan menambal (patch) image 6.0.0 yang sudah ada, bukan dengan membangun ulang image dari commit baru. Oleh karena itu, commit hash di dalam image identik antara 6.0.0 dan 6.0.1.Untuk informasi lebih lanjut, lihat hotfix.

