Gitでローカル専用の変更を保持する方法はある？

Question

Git/Githubを使ってチームで開発しているときに、
例えばローカルでテストするときだけ設定ファイルやコードの中身を変更したいというようなことがたまにあります。

そのような場合は、Gitの管理対象ファイルである場合は一旦変更してテストが終わったらまた戻す、ということを繰り返すことになってしまいます。

それは面倒なので、ある変更をローカルの全てのブランチで保持する(かつコミットには反映させない)といったことをする方法はあるでしょうか？(もしくはいちいち変更する手間を減らす方法)

もちろんチームで開発環境を揃えるのが一番なのですが、外部のレポジトリとかだとなかなか難しいです。

[追記]
質問しておいてあれなのですが、
手軽にできる方法で私の目的に合っているものとして以下の方法を思いつきました。

• ローカルのmasterブランチからmy_envブランチを生やす。
• my_envブランチにて、開発用の変更をしてコミットする(コミットAとします)。
• 開発ブランチは全てmy_envブランチから生やす。
• リモートにpushする際に、 git rebase -i でコミットAのみを削除する。

あまり美しくない方法で、コンフリクトなど問題もあるかもしれませんが・・・。

Answer 1

ローカルで行う変更だけ別ファイルに切り出せるのであれば、切り出した上でそのファイルを.gitignoreするのが手っ取り早いです。

ファイルの一部だけ変更する必要があるような場合には、assume-unchangedやskip-worktreeのような手段があります（Qiita）。もちろん、設定中のファイルをリモートで更新すると不整合になりかねないので、要注意ではあります。

Comments

[namenamenameko]

ありがとうございます！Gitは色々機能があり深いですね・・調べて見ます！

Answer 2

私がよくやっている手は環境変数＋外部ディレクトリから操作する方法です。
Dockerによる開発と相性が良いのでよく使っています。

AWSのAPIを利用するようなケースではキーがバレると困りますが、
外部のサービスを利用しない場合は公開しても特に問題無い情報しかないのでGitHubで管理しても構わないと思います。

環境構築用のプロジェクトを作成して流し込む方法を取っています。
簡単なディレクトリ構造と、docker-compose.ymlの中身を紹介します。
(他の依存するプロジェクトが無ければdocker-compose.ymlは基本的に1個で済むので放り込んでしまえば良いかと思います)

/home/user-name/projects/
  既存のプロジェクト/
    src/
    schema/
      ddl.sql
    entrypoint.sh
  操作用のプロジェクト/
    docker-compose.yml

version: '3'
services:
  mysql:
    image: mysql
    environment:
      MYSQL_ROOT_USER: &mysql-user root
      MYSQL_ROOT_PASSWORD: &mysql-pass password
      MYSQL_DATABASE: &mysql-db test
    volumes:
      - ../main-project/schema/ddl.sql:/docker-entrypoint-initdb.d/0_ddl.sql
    networks:
      - develop_default
  api:
    image: node
    environment:
      VERBOSE: "true"
      PORT: 80
      MYSQL_USER: *mysql-user root
      MYSQL_PASSWORD: *mysql-pass password
      MYSQL_DATABASE: *mysql-db test
    ports:
      - "8080:80"
    volumes:
      - ../main-project:/opt/projects/main-project
    command: node /opt/projects/main-project/entrypoint.sh
    depends_on:
      - mysql
    networks:
      - develop_default
networks:
  develop_default:

Comments

[namenamenameko]

ありがとうございます！恥ずかしながらパッと理解できなかったのですが、
「ディレクトリ外にdockerの仮想環境を作り、その中でコードをいじる」というイメージでしょうか？？
勉強不足のため調べて見ます><

[miyabi-sun]

> 設定ファイルやコードの中身を変更したい

「設定ファイルを作らない」という解決方法だと思ってください。
環境変数を使えば、プログラムの外から文字列が流し込めます。

Windows・Linux・Mac等のOSには「環境変数」という一人のユーザーがパソコンにログインした時に持ち続ける文字列という概念があります。

DockerやVagrantでテスト用のマシンを立ち上げた時に、
テストに応じた値に環境変数を設定してあげます。

PHP等のプログラム内で環境変数を元にif文で処理を割り振るなどの対応策が行えます
http://php.net/manual/ja/function.getenv.php

> コードの中身を変更したい

デバッグする時にコード内にログを吐いたり、文字列を出力するのは仕方ないですが、
基本的にそういう事をするのは悪手なので減らす道を模索していきましょう。
Gitに流れたら最悪ですからね…従って質問文のコードを挿し込むというアプローチはよろしくありません。

処理を細かく分けてモジュール化し、
コマンド一つでそのモジュールをテストするプログラムを書いて何度も実行。
これがあるべき姿で、ユニットテストと呼ばれるジャンルになります。

[namenamenameko]

なるほど！ありがとうございます！！