メインコンテンツへスキップ

はじめに

開発に取りかかる前に、以下の点を理解しておいてください。
  • 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] のようなタグを付けます。これは Overleaf 公式 Community Edition の v[X.x.x] に対応することを示します。注意: このタグは変更不可です!
  • 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 を担当しています。自分のマシンでイメージをビルドする必要はありません。以下のすべてのイメージはワークフローによってビルドされ、手動トリガーを持つものはワンクリックでビルドできます。
  • 開発用イメージは、linux/amd64 と linux/arm64 向けに、それぞれ 1 つのマイクロサービス(web、webpack、clsi など)を含みます。Codespace のセットアップでは、bin/build を実行する代わりに develop/docker-compose.image.yml を通じてこれらを pull します。
  • 運用イメージは、変更をエンドツーエンドでテストするための完全なシングルコンテナイメージ(sharelatex/sharelatex と同様)です。ops:latest は server-pro へのプッシュ時にのみ更新され、PR にはタイムスタンプ付きのタグのみが付与されます。これらのイメージは 7 日間保持され、テスト専用です。
  • リリースイメージはユーザーがデプロイするイメージです。バージョンはブランチ名から決まるため、release-v6.3.0 は overleaf-pro:6.3.0 を公開します。
1

ワークフローを手動で実行する

Actions タブを開き、左側でワークフローを選択して Run workflow をクリックし、確定します。Build Operations Image には、キャッシュされたレイヤーが古くなった場合のための Build without cache オプションもあります。
2

フォークでビルドする

同じワークフローはフォークでも実行できます。フォークで Actions を有効にし、その Actions タブから実行してください。イメージは組み込みの GITHUB_TOKEN を使って ghcr.io/<your-name>/overleaf-pro/... にプッシュされるため、シークレットは不要です。Sync Upstream Code と古いイメージのクリーンアップは ayaka-notes でのみ実行されます。Build Release Image を実行するには、フォークに release-v* ブランチが必要です。
イメージがどのコミットからビルドされたかを確認するには:運用イメージのタグは短いコミットハッシュで終わり、リリースイメージは com.overleaf.pro.revision ラベルにそれを保持しています(以下の Q&A にある docker inspect を参照)。

Q&A

まず、Docker イメージを pull し、次のコマンドを実行してこの Docker イメージのラベルを確認します。
bash
その後、コミット(b0d05c0) がアップストリームの master ブランチに存在するかを確認できます。
これは想定された動作です。6.0.1 リリースは、6.0.0 イメージの上に構築されたマイナーパッチリリースです。変更は新しいコミットからイメージを再ビルドするのではなく、既存の 6.0.0 イメージにパッチを当てることで適用されています。そのため、イメージ内のコミットハッシュは 6.0.0 と 6.0.1 で同一になります。詳細については、hotfix を参照してください。
最終更新日 2026年11月20日