git ignoreを使ってファイルを無視する方法【初心者向け】

初心者向けにgit ignoreを使ってファイルを無視する方法について解説しています。gitの管理下に置きたくないファイルが出てきた際に便利です。開発現場でも役立つ知識になるので、ぜひ今のうちに理解しておきましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が1,000以上あります。

Git(ギット)はとても便利なバージョン管理システムです。

今回は、Gitの使用においても重要なgit ignoreの使い方を紹介していきたいと思います。

同様に役立つGithubの使い方も解説しているので、合わせてご覧ください。

 

なお本記事はTechAcademyのオンライン完結のGitHub講座のカリキュラムをもとに執筆しています。

 

20160620

 

田島メンター!!gitでpushしたくないファイルがあるんですけど、そのファイルだけ外す方法ってないんですか〜?

 

20163020-2

 

あ、それならgit  ignoreで外すことができるよ。

 

20160620

 

どうやるんですか〜?

 

 

git ignoreとは

gitで開発を行っていると、gitの管理下に置きたくないファイルが出てくることがあります。

  • プロジェクトのmetaデータ(開発環境で自動作成されるデータ)
  • コンパイル、ビルドした時に作成されるデータや実行形式ファイル
  • その端末固有の設定情報が記載された環境変数などのファイル
  • セキュリティ上、共有したくないファイル

必要ないmetaデータやコンパイルデータをコミットしてしまうと、目当てのソースコードを見つけにくくなります。また、環境変数などのファイルをコミットしてしまうと、セキュリティ上良くないことになりかねません。

そこでgitではgit ignoreという機能を利用して、gitの管理外に置くファイルを設定することができます。

 

git ignoreを使用してみる

それではgit ignoreを実際に使用してみましょう。

sampleというディレクトリ内で「sample.html」というファイルを作成してみてください。

そしてgit statusで確認してみると以下のようにファイルがアントラッキング状態であることを示すメッセージが表示されます。アントラッキング状態というのは、gitの管理対象のファイルであることを表します(詳しくは、git add の記事を参照して下さい)。

git status

git06_01

このようにsample.htmlはgitの管理下にあることが確認できます。

次に「.gitignore」を使用して、sample.htmlをgitの管理外に置いてみましょう。

sampleディレクトリ内に「.gitignore」というファイルを作成してsample.htmlと記入してください。

sample.html

そしてgit statusを確認すると以下のようにsample.htmlの表示が消え、今作成した.gitignoreファイルが表示されていることが分かります。このことから、sample.htmlはgitの管理外に置かれていることがわかります(逆に、.gitignoreファイルはgitの管理対象であることも確認できます)。

 

[PR] 現役エンジニアに質問しながらプログラミングを習得する学習方法とは

git ignoreの書き方

それでは、git ignoreファイルの書き方について確認していきましょう。git ignoreファイルには、ファイル名を指定するだけでなく、ディレクトリを指定したり、コメントを書いたりすることが可能です。

 

ファイル名

ファイル名を指定した場合、対象のファイルはgitの管理外となります。

sample.html

 

コメント

# で始まる行はコメントです。

# コメントです

 

ディレクトリ

ディレクトリ名を指定した場合、対象のディレクトリはgitの管理外となります。

ディレクトリ名は、末尾に / を付けて指定します。

work/

 

ファイルの種類を指定

* を使うと特定の種類のファイルをgitの管理外とすることができます。以下は、htmlファイルを管理外とする例です。

*.html

! を使うと、gitの管理対象とします。以下は、htmlファイルを管理外とするが、sample.htmlだけは管理対象とする例です。

*.html

!sample.html

 

今回の記事は以上です。

 

20160620

 

git ignore、とても便利ですね♪

 

20163020-2

 

そうだね。OSごとにpushしたくないファイルが設置されていることがあるから、そういうのもignoreで除去すると楽だね♪

 

20160620

 

そうですね♪

 

まとめ

今回はgit ignoreについて解説していきました。

git ignoreを使用すればgitの管理下に置くファイルを制限することができ、gitでのバージョン管理がさらに行いやすくなります。ぜひマスターするようにしましょう。

[お知らせ]TechAcademyでは自宅で学べるオンライン完結のGitHub講座を開催しています。わからないことをチャットで質問すると、現役エンジニアのメンターが毎日すぐに回答します。