.gitignore 説明
.gitignoreファイルは、Git リポジトリ内で管理されないファイルやディレクトリを指定するための設定ファイルです。このファイルにリストされたファイルやディレクトリは、Git のバージョン管理から除外されます。.gitignoreファイルを使用することで、不要なファイルやディレクトリがリポジトリに含まれないようにすることができ、Git 操作をより効果的に管理できます。
以下は.gitignoreファイルの主なポイントと説明です。
-
ファイルとディレクトリの無視:
.gitignoreファイルでは、特定のファイルやディレクトリを無視するためのパターンを指定します。これらのパターンは、リポジトリ内のファイルパスに一致するものが無視対象となります。 -
コメント:
#文字で始まる行はコメント行であり、説明を追加するために使用します。コメント行は無視されます。 -
パターンの書き方:
.gitignoreファイルに指定するパターンは、次のように書きます。- 単純な一致: ファイル名やディレクトリ名をそのまま記述します。例:
myfile.txt - ワイルドカード: ワイルドカード文字（
*や?）を使用してパターンを指定できます。例:*.log（すべての.log ファイルを無視）、test?.txt（test1.txt や test2.txt を無視） - ディレクトリ: ディレクトリを無視する場合、ディレクトリ名の末尾にスラッシュ(
/)を付けます。例:/build/（build ディレクトリとその中身を無視）
- 単純な一致: ファイル名やディレクトリ名をそのまま記述します。例:
-
優先順位:
.gitignoreファイル内のパターンは、上から下に評価されます。より上位に記述されたパターンが優先されます。したがって、より具体的な無視ルールを上に配置し、一般的なルールを下に配置することが一般的です。 -
サブディレクトリへの適用:
.gitignoreファイルは、そのファイルが存在するディレクトリ内およびそのサブディレクトリに適用されます。したがって、特定の無視ルールはサブディレクトリにも影響を与えます。 -
.gitignoreの共有:.gitignoreファイルは Git リポジトリ内に保存され、他の開発者と共有できます。共有することで、プロジェクト全体で同じ無視ルールが適用されます。
.gitignoreファイルの作成とカスタマイズは、プロジェクトの要件に合わせて行われるべきであり、不要なファイルやディレクトリをリポジトリに含めないための重要なツールです。
.gitignore 作成方法
以下は、.gitignore ファイルを作成する方法のステップです。
-
テキストエディタを開く:
.gitignoreファイルを作成するために、お好みのテキストエディタを開きます。コマンドライン上でテキストエディタを使うことも、グラフィカルなテキストエディタを使うこともできます。 -
.gitignoreファイルを作成する:
テキストエディタを開いたら、新しいファイルを作成し、ファイル名を.gitignoreとします。このファイル名は、ドットで始まる名前であるため、隠しファイルとして扱われます。ファイル名に拡張子は不要です。 -
無視するファイルやディレクトリのパターンを追加:
.gitignoreファイルに、無視したいファイルやディレクトリのパターンを追加します。以下は、一般的な.gitignoreファイルの例です。# ディレクトリを無視する例 /bin/ /obj/ # 特定のファイルを無視する例 debug.log secret.txtこの例では、/bin/ディレクトリと/obj/ディレクトリを無視し、
debug.logファイルとsecret.txtファイルを無視します。ファイルやディレクトリのパスは、Git リポジトリのルートからの相対パスで指定します。 -
.gitignoreファイルを保存:
パターンを追加したら、ファイルを保存します。 -
Git リポジトリにコミット:
.gitignoreファイルを Git リポジトリにコミットします。これにより、他のチームメンバーやクローンしたリポジトリでも無視されるファイルやディレクトリの設定が共有されます。
.gitignore ファイルは、プロジェクトごとに異なるものにすることができ、特定のファイルやディレクトリを無視して、リポジトリ内の不要なデータを削減できます。プロジェクトのニーズに合わせてカスタマイズしてください。
参考
下記は Github のテンプレートのコレクションとなります。
