Git の無視

Git は作業コピーのあらゆるファイルを次の３つのうちの１つとみなします。

1. 追跡済み - 以前にステージまたはコミットされたファイル。

2. 未追跡 - ステージまたはコミットされていないファイル。

3. 無視 - Git が明示的に無視するように指示されたファイル。

無視されるファイルは通常、リポジトリーソースから派生するか、またはコミットされないようにするビルド成果物およびマシン生成ファイルです。一般的な使用例の一部を次に挙げます。

• /node_modules または /packages のコンテンツなどの、依存関係のキャッシュ

• コンパイルされたコード (.o、.pyc、および .class デバッグ

• ビルド出力ディレクトリ (/bin、/out、または /target など)

• 実行時に生成されるファイル (.log、.lock、または .tmp など)

• 非表示のシステムファイル (.DS_Store または Thumbs.db など)

• .idea/workspace.xml などの個人用 IDE 設定ファイル

無視されたファイルは、.gitignore という名前の特別なファイルで追跡されます。これはリポジトリのルートでチェックインされます。明示的な git ignore コマンドはありません。無視したい新規ファイルがある場合には、代わりに .gitignore ファイルを手動で編集してコミットする必要があります。.gitignore ファイルには、ファイルを無視すべきかどうかを決定するためにリポジトリ内のファイル名と一致するパターンが含まれています。

このドキュメントでは、次のトピックについて説明します。

• Git の無視パターン

• リポジトリ内の共有 .gitignore ファイル

• 個人用の Git 無視規則

• グローバルな Git 無視規則

• 以前にコミットされたファイルを無視

• 無視されたファイルのコミット

• 無視されたファイルを隠す

• .gitignore ファイルのデバッグ

Git の無視パターン

.gitignore はグロブパターンを使用してファイル名を照合します。様々なシンボルを使用して独自のパターンを作成できます。

** この説明は、ご使用の .gitignore ファイルが規則と同様に、リポジトリの最上位ディレクトリにあることを想定しています。リポジトリに複数の .gitignore ファイルがある場合、単に頭の中で "リポジトリルート" を ".gitignore ファイルを含むディレクトリ" と置き換えてください (そして、チームが混乱しないようにファイルを統合することを検討してください)。*

これらの文字に加えて、# を使用して .gitignore追加します。

1# ignore all logs
2*.log

.gitignore パターン文字が含まれるファイルまたはディレクトリがある場合、\ を使用してそれらのパターン文字をエスケープできます。

1# ignore the file literally named foo[01].txt
2foo\[01\].txt

リポジトリ内の共有 .gitignore ファイル

Git は通常 .gitignore ファイルで定義される規則を無視します。このファイルは、ユーザーのリポジトリのルートにあります。しかし、ユーザーのリポジトリ内の様々なディレクトリにある複数の .gitignore ファイルを定義するという選択肢があります。特定の .gitignore ファイルの各パターンがそのファイルがあるディレクトリに対してテストされます。ただし、従来の、最もシンプルな方法はルートで単一の .gitignore ファイルを定義することです。.gitignore ファイルをチェックインすると、ユーザーのリポジトリ内の他のファイルと同様にバージョン管理され、プッシュ時にチームメートと共有されます。一般的に、.gitignore に含めるパターンは、リポジトリの他のユーザーにとってメリットになるものに限定すべきです。

個人用の Git 無視規則

また、特定のリポジトリの個人用無視パターンを .git/info/exclude　にある特別なファイルに定義することもできます。これらはバージョン管理されず、ユーザーのリポジトリと共に配布されないので、自分にのみメリットがある可能性が高いパターンを含めるには適した場所です。たとえば、カスタムロギング設定や、リポジトリの作業ディレクトリにファイルを生成する特別な開発ツールがある場合、それらを .git/info/exclude に追加して、誤って自分のリポジトリにコミットされないようにすることができます。

グローバルな Git 無視規則

さらに、Git core.excludesFile プロパティを設定することで、ローカルシステム上のすべてのリポジトリに対するグローバル Git の無視パターンを定義することができます。このファイルは自分で作成する必要があります。グローバルな .gitignore ファイルを配置すべき場所がよくわからない場合は、ホームディレクトリでかまいません (後で簡単に見つけることができます)。ファイルを作成したら、git config でその場所を設定する必要があります。

1$ touch ~/.gitignore
2$ git config --global core.excludesFile ~/.gitignore

プロジェクトによって異なる種類のファイルが関連するため、グローバルに無視するパターンは慎重に選択する必要があります。特殊なオペレーティング システム ファイル (.ds_store や thumbs.db など) または一部の開発ツールで作成された一時ファイルが、グローバルに無視する一般的な候補になります。

以前にコミットされたファイルを無視

過去にコミットしたファイルを無視する場合、リポジトリからファイルを削除してから、それに対して .gitignore ルールを追加する 必要があります。--cached オプションを git rm で使用すると、ファイルはリポジトリから削除されますが、無視されたファイルとして作業ディレクトリに残ります。

1$ echo debug.log >> .gitignore
2  
3$ git rm --cached debug.log
4rm 'debug.log'
5  
6$ git commit -m "Start ignoring debug.log"

ファイルをリポジトリとローカル ファイル システムの両方から削除する場合は、--cached オプションを省略できます。

無視されたファイルのコミット

-f (または --force) オプションを git add で使用して、無視されたフィルをリポジトリに強制的にコミットすることができます。

1$ cat .gitignore
2*.log
3  
4$ git add -f debug.log
5  
6$ git commit -m "Force adding debug.log"

一般的なパターン (*.log など) が定義されていても、特定のファイルをコミットしたい場合は、これを行うとよいでしょう。ただし、より良い解決策は一般的な規則の例外を定義することです。

1$ echo !debug.log >> .gitignore
2  
3$ cat .gitignore
4*.log
5!debug.log
6  
7$ git add debug.log
8  
9$ git commit -m "Adding debug.log"

これは、チームメイトにとって明白で、混乱を招きにくいアプローチです。

無視されたファイルを隠す

git stash は、ローカルの変更を一時的に棚上げして取り消した後、再適用できる高度な Git 機能です。既定では、git stash では無視されたファイルは無視されて、Git の追跡対象ファイルに対する変更のみが一時退避されます。ただし、--all オプションを指定して git stash を呼び出して、無視されたファイルや追跡対象外のファイルに対する変更も一時退避できます。

.gitignore ファイルのデバッグ

.gitignore パターンを複雑化したかパターンが複数の .gitignore ファイルに分散している場合は、特定のファイルが無視されている理由を特定しにくい可能性があります。git check-ignore コマンドを-v (または --verbose) オプションを指定して使用し、特定のファイルが無視される原因となっているパターンを特定できます。

1$ git check-ignore -v debug.log
2.gitignore:3:*.log  debug.log

次のような出力が得られます。

1<file containing the pattern> : <line number of the pattern> : <pattern>    <file name>

必要に応じて、複数のファイル名を git check-ignore に渡せます。名前自体は、リポジトリに存在するファイルと一致する必要はありません。