この記事について
対象とする方
github 初心者の方を想定しています。
使う場面
git push したら不要なデータも github に上がってしまい、それらのデータを今後アップしないようにしたいとき
例:.DS_Store , node_modules などのディレクトリやその他ファイル
.gitignore とは?
システム開発に不要なファイル、ディレクトリの名前を、とあるファイルにリストアップしておくと、github に上がらないようになる仕組みです。
.gitignore の使い方
※ 実行環境はMacです
github上で共有したくないが、すでに git push してしまったデータへの対処
今後 git push されないようにするため、キャッシュの削除という作業を行います。
-
当該データがある階層に行きます
(参考) ターミナル操作
$ cd ディレクトリの場所
ディレクトリの場所に移動する
$ cd ~/
ホームディレクトリに移動する
$ cd ..
1つ上の階層に移動する -
以下を入力します
$ git rm --cached データ名
-
成功すると以下のように表示されます
rm データ名
.gitignore ファイルを作る
.gitignore というファイルを作ると、それが不要なデータ名称のリストとして認識されます。
- .git ディレクトリがある階層に行きます
- .gitignore という名前のファイルを作成します
(参考) ターミナル操作
$ touch ファイル名
中身が空のファイルを作る
.gitignore ファイルに入力する
決められた形式で、データ名をリストアップします。
- 共有したくないデータ名をそのまま入力します
例).DS_Store というディレクトリを共有したくなければ、 .DS_Store と入力
※ その他、ワイルドカード等を使ってデータ名を指定することも可能です。方法は他の記事をご参照ください。
状態を確認し、 git push する
- 通常通り git add をします
- git status で、 .gitignore に入力したデータが追跡対象から削除されているかを確認します
- 問題がなければ、git commit , git push します
github上の状態を確認する
最後に、 git hub 上でも .gitignore に入力したデータがなくなっているかを確認しましょう。
※ .gitignore のファイル自体はgithub上で共有されます
参考記事
参考にさせていただきました。ありがとうございます。