.gitignoreとは
- プロジェクトディレクトリの中に置く必要があるが履歴管理したくないファイルがある
- ここに書かれたパターンのファイルやディレクトリはGitから無視される
Git管理の対象とは?
- 開発の対象
- 開発者に共通の設定
管理対象から外すべきもの
- 依存ライブラリの実体:例えば
node_modules
- 開発者単位の設定:エディタの設定など。例えば
.vs
- ビルドの成果物:
bin
/obj
/dist
など - 機密情報:例えば
.env
外すかどうか悩むもの
- 自動生成するソースコード
ビルド時に生成し直す、という戦略もあり。この場合.gitignoreに書く
どちらかと言えばバージョン管理したい - ビルドの成果物
管理しておきたい場合もある!
機密情報の管理について
- 環境変数から取得(値はGit以外の方法で共有)
dotenv
などのツールを利用すると環境毎の切り替えがらく - KeyVaultなどのサービスを利用
.gitignoreの生成
- プロジェクトを最初の作成するときに、どこかからかサンプルを持ってくるのが吉
使っている言語やツールでだいたい.gitignoreの内容は定まる - でも、一度はゼロから書くのがおすすめ!
うっかりGit管理してしまったら
- 過去の履歴は消せないのであきらめる
- .gitignoreに追記
-
git rm xxxx
で管理から外す
最後に
- .gitignoreを書くと開発環境の知識が深まる