Gitでリポジトリ管理されているファイルをローカルで無視する

SHARE

いくつか方法があるが、正直どれも使わないに越したことはないが業務上の様々なしがらみなどでやむを得ず使うハメになることがある

ローカルで無視しておきたいがリモートで変更があったときには検知したいケース

リモートの変更まで無視してしまうと事故の元なので一番オススメ
git update-index --[no-]skip-worktreeを使う

  • .envのような個々人の環境によって異なるものがリポジトリ管理対象になっているときに使える
  • ブランチの切り替え時のコンフリクト対策としてはスクリプトを組んでおくと楽

ブランチ切り替え時のテクニック

  • ブランチで--skip-worktreeとなっている対象の変更を隠す
# --skip-worktreeの一括解除
git ls-files -v | grep ^S | sed -r 's/^S.(.+)$/\1/g' | xargs git update-index --no-skip-worktree
# 出てきた変更を全てスタッシュに入れる
git stash push -q -m stash_skiptree
  • 前項で隠した変更を再現して、--skip-worktreeし直す
# stashから戻す
git stash pop -q
# この時点での差分に対し--skip-worktree
git diff --name-only HEAD | xargs git update-index --skip-worktree

常に無視しておきたいケース

リモート側で重大な変更があったときにローカルで検知できないので事故りやすい
git update-index --[no-]assume-unchangedを使う
使ったことないので存在だけ記述して終わり

リポジトリの管理下にないファイルを常に無視するケース

--[no-]skip-worktreeも--[no-]assume-unchangedも使えないときにユースケースが存在するやつ

  • .git/info/excludeに無視対象のパスを記述することで無視できる
  • 自分のローカルにだけこっそり存在するdocker-compose.override.yamlみたいなのを無視するときに使える

前の記事

GitHub Actions Icon
GitHub Actionsのワークフローで変数を利用する

次の記事

nginxのリバースプロキシでBasic認証を通す
Nginx logo