ファイルを無視する

最終更新日：2024-11-24 | ページの編集

概要

質問

  • Git で追跡したくないファイルを指定するにはどうすればよいですか？

目的

  • Git で追跡したくないファイルを指定しましょう
  • ファイルを無視する利点を理解しましょう

Git に追跡して欲しくないファイル、例えばエディタが作成したバックアップファイルやデータ解析中に作られた中間ファイルなどは、どう対処すればいいのでしょう？ 例として、いくつかファイルを作ってみましょう：

BASH 

$ mkdir results
$ touch a.csv b.csv c.csv results/a.out results/b.out

そして Git が何と言うか見てみましょう：

BASH 

$ git status

出力 

On branch main
Untracked files:
  (use "git add <file>..." to include in what will be committed)

	a.csv
	b.csv
	c.csv
	results/

nothing added to commit but untracked files present (use "git add" to track)

これらのファイルをバージョンコントロールで保存するのはディスク容量の無駄になります。 さらに、これら全てが表示されると、本当に必要な変更点に集中できなくなってしまうかもしれないので、 Git にこれらのファイルを無視してもらいましょう。

これをするには、.gitignore というファイルをルートディレクトリに作ります：

BASH 

$ nano .gitignore
$ cat .gitignore

出力 

*.csv
results/

入力したパターンは、 Git に .dat で終わるファイル名とresults ディレクトリ内にあるファイルを無視するように指示しています。 （Git がすでに追跡しているファイルは、引き続き追跡されます。）

このファイルを作った後git status の出力を見てみると、大分綺麗になっています：

BASH 

$ git status

出力 

On branch main
Untracked files:
  (use "git add <file>..." to include in what will be committed)

	.gitignore

nothing added to commit but untracked files present (use "git add" to track)

Git は新しく作られた .gitignore ファイルしか表示していません。 このファイルは追跡しなくても良いかと思うでしょうが、リポジトリを共有する際に、他の人達も私達が無視したものを同じように無視したいでしょう。 なので、.gitignore を追加してコミットしましょう：

BASH 

$ git add .gitignore
$ git commit -m "Ignore data files and the results folder"
$ git status

出力 

On branch main
nothing to commit, working tree clean

.gitignore を作った事によって、間違えて不要なファイルをリポジトリに追加する事を防ぐことができます：

BASH 

$ git add a.csv

出力 

The following paths are ignored by one of your .gitignore files:
a.csv
Use -f if you really want to add them.

この設定を強制的に無視してファイルを追加するには、git add -f を使います。 例えば、git add -f a.csv と入力します。 もちろん、無視されたファイルの状況はいつでも見ることができます：

BASH 

$ git status --ignored

出力 

On branch main
Ignored files:
 (use "git add -f <file>..." to include in what will be committed)

        a.csv
        b.csv
        c.csv
        results/

nothing to commit, working tree clean

埋もれた（ネストされた）ファイルを無視する

以下のようなディレクトリ構造があるとします：

BASH 

results/data
results/plots

results/data ではなく、results/plots のみを無視するにはどうすればいいのでしょう？

results/plots 内のファイルのみを無視するのであれば、.gitignore に /plots/ サブフォルダを無視するように.gitignore に以下の文を加えれば解決できます：

出力 

results/plots/

この行によって、results/plotsの内容だけが無視され、results/dataの内容は無視されません。

様々なプログラミングの問題と同様に、この無視ルールが守られるようにする回答方法はいくつかありま。 「ネストされたファイルを無視する：バリエーション」の演習は、わずかに異なるディレクトリ構造を持っており、別の解決策を提示しています。「ネストされたファイルを無視する：バリエーション」の演習は、わずかに異なるディレクトリ構造を持っており、別の解決策を提示しています。 Further, the discussion page has more detail on ignore rules.

無視の対象に特定のファイルを含める

final.csv以外の、ルートディレクトリ内にある他の .data ファイルを全て無視したい場合はどうすればいいのでしょう？ ヒント： ! （感嘆符）が何をするのか調べてみましょう。

以下二文を .gitignore に加えましょう：

出力 

*.data           # 全ての data ファイルを無視する
!final.data      # final.data は対象から除外する

感嘆符は、無視してあったファイルを対象から外します。

このレッスンで.csvファイルをコミットしたことがあるので、この新しいルールでは無視されません。 ルートディレクトリに追加された .csv ファイルの以後の追記のみが無視されます。

Ignoring Nested Files: Variation

前の入れ子になったファイルの練習問題と同様のディレクトリ構造ですが、少し異なるディレクトリ構造になっているとしましょう：

BASH 

results/data
results/images
results/plots
results/analysis

results フォルダ内のコンテンツの全てを無視する、 しかし results/data は無視しない。そんな場合はどうするでしょうか？

ヒント： 以前に ! 演算子を使って例外を作った方法を少し考えてみてください。

results/ のコンテンツは無視したいが、 results/data/ のコンテンツは無視したくない場合、 .gitignore を変更して、 results フォルダの内容は無視する、しかし results/data サブフォルダのコンテンツは例外として設定することができます。 あなたの .gitignore は次のようになるでしょう：

出力 

results/*               # ignore everything in results folder
!results/data/          # do not ignore results/data/ contents

ディレクトリ内の全てのデータファイルを無視する

空の.gitignoreファイルがあり、以下のようなディレクトリ構造があるとします：

BASH 

results/data/position/gps/a.csv
results/data/position/gps/b.csv
results/data/position/gps/c.csv
results/data/position/gps/info.txt
results/plots

result/data/position/gps 内にある全ての .data ファイルを無視する一番短い.gitignoreルールは何でしょう？ info.txt ファイルは無視しないでください。

results/data/position/gps/*.data を使えば results/data/position/gps 内にある全ての .data ファイルを無視できます。 results/data/position/gps/info.txt ファイルは無視されません。

Ignoring all data Files in the repository

Let us assume you have many .csv files in different subdirectories of your repository. For example, you might have:

BASH 

results/a.csv
data/experiment_1/b.csv
data/experiment_2/c.csv
data/experiment_2/variation_1/d.csv

How do you ignore all the .csv files, without explicitly listing the names of the corresponding folders?

In the .gitignore file, write:

出力 

**/*.csv

This will ignore all the .csv files, regardless of their position in the directory tree. You can still include some specific exception with the exclamation point operator.

ルールの順番

以下の内容の .gitignore ファイルがあるとします：

BASH 

*.csv
!*.csv

結果的に何が無視されるのでしょうか？

感嘆符 ! は無視してあったファイルを対象から除外する効果があります。 !*.csv は、その前に入力されている .csv ファイルを対象から外すので、全ての .csv ファイルは引き続き追跡されることになります。

ログファイル

仮に log_01、 log_02、 log_03、というように、中間的にログファイルを作成するスクリプトを書いたとします。 これらのログファイルは取っておきたいのですが、git で追跡したくありません。

  1. log_01、 log_02、などのファイルを無視するためのルールを一つだけ .gitignore に入力してください。

  2. 入力したパターン正常に動作しているか確認するために log_01 などのファイルを作成してください。

  3. 最終的に log_01 ファイルがものすごく重要であることが分かりました。.gitignore を編集せずに、このファイルを追跡しているファイルに加えてください。

  4. 隣の人と、追跡したくないファイルは他にどのようなものがあるのか、そして.gitignore に何を入力すればこれらのファイルを無視できるのかを話し合ってください。

  1. log_* もしくは log* を .gitignore に加えます。

  2. git add -f log_01 を使って log_01 を追跡しましょう。

まとめ

  • .gitignore で無視するファイルを指定する