😸
【Git】リポジトリに`.gitignore`を配置してgitが管理しないファイルを指定する
はじめに
gitでディレクトリ内のファイルをステージングする際、git add .
を使うと一括でやってくれるので便利ですよね。ただ、そのディレクトリ内にバージョン管理してほしくないファイル(リモートリポジトリにアップしたくないファイル)があると、該当ファイルを一つずつgit add
コマンドに記載していかないといけないので不便です。そんな時に役立つのが.gitignore
です。
この記事では.gitignore
について勉強した内容を簡単に纏めます。
この記事の想定読者:
・新人エンジニア
・gitを勉強し始めた人
gitignoreとは
.gitignore
は、Gitバージョン管理システムで使用される特殊なファイルで、Gitが無視する(つまりバージョン管理から除外する)ファイルやディレクトリを指定します。
使い方
.gitignore
ファイルは、プロジェクトのルートディレクトリに配置され、その中には無視するパターンが一行ごとに記述されます。以下に、一般的な.gitignore
ファイルの例を示します:
# Ignore all .a files
*.a
# But do track lib.a, even though you're ignoring .a files above
!lib.a
# Only ignore the TODO file in the current directory, not subdir/TODO
/TODO
# Ignore all files in the build/ directory
build/
# Ignore all .tmp files
*.tmp
上記の例では、以下のようなルールが適用されます:
-
*.a
は、全ての.a
拡張子を持つファイルを無視します。 -
!lib.a
は、lib.a
という名前のファイルは無視しないことを指定します。このルールは、上記の*.a
ルールを上書きします。 -
/TODO
は、現在のディレクトリのTODO
という名前のファイルだけを無視します。サブディレクトリのTODO
ファイルは無視されません。 -
build/
は、build/
ディレクトリとその中の全てのファイルを無視します。 -
*.tmp
は、全ての.tmp
拡張子を持つファイルを無視します。
.gitignore
ファイルは、ビルドの出力、ログファイル、ローカル設定、パーソナルエディタの設定、システム生成のファイルなど、バージョン管理する必要がないファイルを指定するのに役立ちます。これにより、リポジトリをクリーンに保つことができます。
Discussion