git ignoreとは？.gitignoreファイルの作成・特定のファイルをGit管理対象外にする方法

git ignoreとは？

git ignore（ギット・イグノアー）とはGitリポジトリ配下において、管理対象（追跡対象）から外すディレクトリや、ファイルを設定するための仕組みです。

ローカルリポジトリ、リモートリポジトリの両方でのGit管理対象外になります。なお、.gitignoreは複数のディレクトリで作成することができます。

使用場面としては、ローカル環境では必要だが本番環境（リモートリポジトリ）に不要なディレクトリや、ファイルなどを誤って本番環境にpushしないためにも必要です。

また、セキュリティの面でも注意が必要です。DB（データベース）などへのログイン情報といった、機密性の高い情報を外部へ公開しないためにも設定する必要があります。

• .gitignoreファイルの作成
• .gitignoreファイルの確認
• .gitignoreファイルでのコメント
• 特定のファイルをGit管理対象外にする
• サブディレクト以下のディレクトと、ファイルをGit管理下にする
• 特定のファイルだけをGit管理外にしない

.gitignoreファイルの作成

vi（テキストエディタ）を使い.gitignoreを作成します。ターミナルや、コマンドプロントを立ち上げ以下のコマンドを入力してください。注意点として Windowsをお使いの方は、viを別途インストールする必要があります。

上記のコマンドを入力後、キーボードの『;』（セミコロン）を押し、『w』、『!』と順に押してください。これで、.gitignoreファイルが作成されます。

.gitignoreファイルの確認

.gitignoreはmacOSなら『Finder』、Windowsなら『エクスプローラー』では基本的に、ファイルの確認ができません。ターミナルや、コマンドプロントを使用して確認することになります。

ターミナル（macOS）の場合は以下になります。

コマンドプロント（Windows）の場合は以下になります。

.gitignoreファイルでのコメント

.gitignoreファイルでのコメントを使用する場合は、『#これがコメントです』のうように『#』の後ろにコメントを記述します。

特定のファイルをGit管理対象外にする

以下のディレクトリ構成とします。

『a.pyと、aa.pyのパス』を記述することで、Gitの対象管理外になります。

結果

サブディレクト以下のディレクトと、ファイルをGit管理下にする

以下のディレクトリ構成とします。

『git-tests』と記述することで、git-testディレクトリ以下をGit管理対象外にし、『a.py』は全サブディレクトリ以下のa.pyがGit管理対象外になります。

結果

特定の拡張子を持ったファイルを、Git管理外にする

以下のディレクトリ構成とします。

『*.txt』と記述することで、全ディレクトリ以下の.txtの拡張子ファイルをGit管理対象外にします。

結果

特定のディレクトリの中身全てを、Git管理外にする

以下のディレクトリ構成とします。

『git-test/』と記述することで、Gitの対象管理外になります。

結果

特定のファイルだけをGit管理外にしない

以下のディレクトリ構成とします。

『!/c.py』と記述することで、c.pyはGitの管理対象外にはなりません。

結果

• 指定したディレクトリ、またはファイルの名のスペルミス
• .gitignore自体のスペルが間違っている
• Git管理下にされたものを、後からgitignoreに追加した場合

指定したディレクトリ、またはファイル名のスペルミス

.gitignoreで指定しているディレクトリ、またはファイル名のスペルミスが考えられます。macOSなら『ls -al』コマンド、Windows『dir』コマンドを使用して、常にどのようなディレクトリやファイルが存在するか、確認しておくことをおすすめします。

また、よくGit管理外にするディレクトリ、またはファイルなどを.gitignoreのテンプレートとして作成するのも尚、良いです。

.gitignore自体のスペルが間違っている

.gitignoreのスペルミスが間違っている場合も指定したディレクトリ、またはファイルは反映されません。細かいですが、.gitignoreの『.』ドットもなければいけません。Git、GItHubを日頃から使用し、その過程で.gitignoreを描き慣れていくことが重要です。

Git管理下にされたものを、後からgitignoreに追加した場合

Git管理下に一度登録されたデェレクトまたは、ファイルは反映されません。ディレクトリ構成を把握し、.gitignoreファイルをあらかじめ設定しておきましょう。万が一指定し忘れた場合は、次の手順を参考にしてください。

• ディレクトまたは、ファイルをGit管理外の場所に移動する
• commitをする
• gitignoreを編集する
• ディレクトまたは、ファイルをGit管理下に戻す

まとめ

git ignore（ギット・イグノアー）の仕組みを利用することで、意図的にGitの管理下を操作できます。また、チーム開発での本番環境とローカル環境でのディレクトやファイルの整理、セキュリティに関する情報を外部に公開しない役割を持っているのが特徴です。