はじめに

今回はGitを使用する際に重要なgit ignoreについて紹介します！

git ignoreとは？

gitを使って開発を行なっていると、管理対象にしたくないファイルが出てくることがあります。
分かりやすいところだと、

.DS_Store(プロジェクトのmetaデータ)
APIKey

などが挙げられると思います。例えばAPIKeyをgitの管理対象にした状態で誤ってGitHubにプッシュしてしまうと、APIKeyを第三者に不正に利用される危険があります。git ignoreを使うことでgitの管理外に置くファイルを設定し、このような問題を解消することができます。

1. コミット前にgit ignoreを設定する方法

Sampleフォルダを作成し、その中に作成したsample.txtをgitの管理対象から外す方法を紹介します。

Sampleフォルダを作成

$ mkdir Sample

Sampleフォルダ内に「sample.txt」と「.gitignore」を作成

$ touch sample.txt
$ touch .gitignore

sample.txtをgitの管理対象から外す

Sampleディレクトリにいる状態で以下のコマンドを打ち込むとsample.txtと.gitignoreが作成できているのが確認できるかと思います。(.gitignoreは隠しファイルなのでlsだけでは確認できません。)

$ ls -a

.gitignoreをテキストエディタで開き、管理対象外にしたいファイル名を書き込みます。今回はsample.txtを書き込むだけでOK!

2. コミットを行なった後にgit ignoreを設定する方法

.gitignoreを作成する前にコミットを行なっていると、上記の手順だけでは特定のファイルを管理対象外にすることはできません。その場合はまずプロジェクトのディレクトリに移動し、1と同様に「.gitignore」を作成の後、.gitignoreに管理対象外にしたいファイルを書き込みます。その後ターミナルで以下のコマンドを実行します。(sample.txtを管理対象外にする場合) 以下のコマンド実行後にコミットを行えばOK!

$ git rm --cached sample.txt
$ git add .