Git Large File Storage（LFS）

Git Large File Storage（LFS）は、Gitリポジトリが大きなバイナリファイルを効率的に管理する際に役立つ、オープンソースのGit拡張機能です。Gitは、テキストファイルへの変更を追跡する場合と同じ方法で、バイナリファイル（オーディオ、動画、画像ファイルなど）への変更を追跡することができません。テキストベースのファイルはプレーンテキストの差分を生成できますが、バイナリファイルに変更を加える場合は、Gitがリポジトリ内のファイルを完全に置き換える必要があります。大容量ファイルを繰り返し変更すると、リポジトリのサイズが大きくなります。時間の経過とともに、このサイズの増加によってclone、fetch、pullなどの通常のGitオペレーションが遅くなる可能性があります。

Git LFSを使用して、大容量のバイナリファイルをGitリポジトリの外部に保存し、Gitが管理するための小さなテキストベースのポインターのみを残します。Git LFSを使用してリポジトリにファイルを追加するとき、GitLabは以下を実行します:

1. Gitリポジトリの代わりに、プロジェクトの設定済みオブジェクトストレージにファイルを追加する。

2. 大容量ファイルの代わりに、Gitリポジトリにポインターを追加する。ポインターには、次のようなファイルに関する情報が含まれています:

   version https://git-lfs.github.com/spec/v1
   oid sha256:lpca0iva5kpz9wva5rgsqsicxrxrkbjr0bh4sy6rz08g2c4tyc441rto5j5bctit
   size 804

   • バージョン - 使用しているGit LFS仕様のバージョン
   • OID - 使用されたハッシュ方式と、{hash-method}:{hash}形式の一意のオブジェクトID
   • サイズ - ファイルサイズ（バイト単位）

3. ストレージサイズやLFSオブジェクトストレージなどのプロジェクトの統計を再計算するジョブをキューに追加します。LFSオブジェクトストレージは、リポジトリに関連付けられているすべてのLFSオブジェクトのサイズの合計です。

Git LFSで管理されるファイルには、ファイル名の横にLFSバッジが表示されます:

Git LFSクライアントは、HTTP基本認証を使用し、HTTPS経由でサーバーと通信します。リクエストを認証すると、Git LFSクライアントは、大容量ファイルをフェッチ（またはプッシュ）する場所に関する指示を受け取ります。

Gitリポジトリのサイズは小さいままなので、リポジトリのサイズ制限に準拠することができます。詳細については、GitLab Self-Managed向けおよびGitLab SaaS向けのリポジトリサイズの制限を参照してください。

Git LFSがフォークでどのように動作するかを理解する

リポジトリをフォークすると、フォークした時点で存在していたアップストリームリポジトリの既存のLFSオブジェクトがフォークに含まれます。新しいLFSオブジェクトをフォークに追加した場合、それらのオブジェクトはフォークだけに属し、アップストリームリポジトリには属しません。オブジェクトストレージの合計は、フォークでのみ増加します。

フォークからアップストリームプロジェクトへのマージリクエストを作成し、そのマージリクエストに新しいGit LFSオブジェクトが含まれている場合、GitLabはマージ後に新しいLFSオブジェクトをアップストリームプロジェクトに関連付けます。

プロジェクト用にGit LFSを設定する

GitLabでは、GitLab Self-ManagedとGitLab SaaSの両方で、Git LFSがデフォルトで有効になっています。サーバー設定とプロジェクト固有の設定の両方を利用できます。

• リモートオブジェクトストレージの設定など、インスタンスでGit LFSを設定するには、GitLab Git Large File Storage（LFS）の管理を参照してください。

• 特定のプロジェクト用にGit LFSを設定するには、以下を実行します:

  1. リポジトリのローカルコピーのルートディレクトリで、git lfs installを実行します。このコマンドにより、以下が追加されます:
     • リポジトリへのpre-push Gitフック。
     • 個々のファイルとファイルタイプの扱いを追跡する.gitattributesファイル。
  2. Git LFSで追跡するファイルとファイルの種類を追加します。

プロジェクト用にGit LFSを有効または無効にする

Git LFSは、GitLab Self-ManagedとGitLab SaaSの両方で、デフォルトで有効になっています。

前提要件:

• プロジェクトのデベロッパーロール以上を持っている必要があります。

プロジェクト用にGit LFSを有効または無効にするには、以下を実行します:

1. 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. 設定 > 一般を選択します。
3. 可視性、プロジェクトの機能、権限セクションを展開します。
4. **Git Large File Storage (LFS)**の切替を選択します。
5. 変更を保存を選択します。

ファイルを追加して追跡する

Git LFSには大容量ファイルを追加することができます。これにより、Gitリポジトリ内のファイルを管理することができます。Git LFSでファイルを追跡するとき、ファイルはGit内のテキストポインターに置き換えられ、リモートサーバーに保存されます。詳細については、Git LFSを参照してください。

プロジェクト用にGit LFSを設定する場合は、.gitattributesファイルをプロジェクトのルートディレクトリに置くようにしてください。ルートレベルの.gitattributesファイルがない場合、プロジェクトのサブディレクトリでLFSを正しく設定した場合でも、UIに警告が表示されます。詳細については、LFS設定の警告メッセージを参照してください。

Git LFSを使用するリポジトリを複製する

Git LFSを使用するリポジトリを複製するとき、GitはLFSで追跡したファイルを検出し、HTTPS経由で複製します。git cloneをuser@hostname.com:group/project.gitなどのSSH URLで実行する場合は、HTTPS認証のためにGitLab認証情報を再度入力する必要があります。

デフォルトでは、GitがSSH経由でリポジトリと通信する場合でも、Git LFSオペレーションはHTTPS経由で実行されます。GitLab 17.2で、LFSの純粋なSSHサポートが導入されました。この機能を有効にする方法については、純粋なSSH転送プロトコルを参照してください。

すでに複製したリポジトリの新しいLFSオブジェクトをフェッチするには、次のコマンドを実行します:

git lfs fetch origin main

既存のリポジトリをGit LFSに移行する

Git LFSを使用して既存のGitリポジトリを移行する方法については、git-lfs-migrateドキュメントを参照してください。

リポジトリの履歴からGit LFSファイルを削除する

Git LFSでファイルの追跡を解除することと、ファイルを削除することの違いを理解しておくことが重要です:

• 追跡解除: ファイルはディスクとリポジトリの履歴に残ります。ユーザーが履歴ブランチまたはタグをチェックアウトする場合にも、ファイルのLFSバージョンが必要になります。
• 削除: ファイルは削除されますが、リポジトリの履歴に残ります。

Git LFSで追跡したファイルを削除するには、ファイルを削除するを参照してください。

ファイルの過去と現在のすべての履歴を完全に消滅させるには、機密情報を処理するを参照してください。

大きなファイルを削除した後にリポジトリのサイズを縮小する

リポジトリの履歴から大きなファイルを削除してリポジトリの合計サイズを縮小する必要がある場合は、リポジトリのサイズを縮小するを参照してください。

関連トピック

• Git LFSを使用して排他的なファイルのロックを設定します。
• ブログ投稿: Git LFS入門
• Git LFSとGit
• GitLab Self-Managed用のGitLab Git Large File Storage（LFS）の管理
• Git LFSのトラブルシューティング
• .gitattributesファイル