ソースコードにパッチファイルを適用するGitコマンド「git apply」について徹底解説！

アプリ開発において「Git」は必須スキルとなってきます。Gitの基本コマンドは知っているけど他のコマンドはよく知らない、Gitコマンドをもっと知って便利に使いたい！と思っている方、また 特定のOSSにコントリビュートしたい！ または オフラインのリポジトリへ変更を適用したい！ という方向けに、この記事では「git apply」コマンドについて解説します。

GitについてはエンベーダーのLinux応用コースで詳しく学ぶことができます。

https://envader.plus/course/5/scenario/1055

様々なGitコマンドを習得し、Gitマスターを目指しましょう！

「git apply」コマンドとは

git applyコマンドは、Gitのパッチファイルを現在のワーキングツリーに適用するためのコマンドです。パッチファイルとは、ソースコードの変更内容を記録したテキストファイルのことで、git diffコマンドやgit format-patchコマンドを使って生成することができます。

「git apply」コマンドでできること

git applyコマンドを使うことで、以下のようなことができます。

• パッチファイルの内容を現在のワーキングツリーに適用する
• 適用した変更を元に戻す
• パッチファイルの適用前に、変更内容の概要を確認する

開発現場での使用例

• オフライン環境での作業

  オフライン環境にあるソースコードなどのリポジトリに、何か別の環境で作成した変更を適用したい時があるとします。そのような場合、後ほど紹介するコマンドを用い事前にパッチファイルを作成し、git applyコマンドでその変更を取り込むことができます。また、コミットではなくワーキングツリーに変更が適用されるだけであるため、簡単にその変更を取り消したり修正したりすることができます。

• OSSプロジェクトへの貢献

  OSS（オープンソースソフトウェア）プロジェクトにコントリビュートする際、プルリクエストを送る代わりにパッチファイルを送ることがあります。特に、メーリングリストでパッチファイルのやり取りを行っているプロジェクトでは、git applyコマンドが重要な役割を果たします。

OSSプロジェクトへのコントリビュート方法の変遷

昔は、OSSプロジェクトへのコントリビュートはメーリングリストを通じたパッチファイルのやり取りが一般的でした。開発者がパッチファイルをメールで送信し、管理者がそれをgit applyなどのコマンドでプロジェクトに取り込む方法です。現在ではGitHubやGitLabなどのプラットフォームの普及により、プルリクエストを使った方法が主流になっていますが、一部のプロジェクトではメールベースの方法が今でも使われています。

「git apply」コマンドの使用方法

git apply コマンドを実行すると、単にワーキングツリーに変更を適用します。つまり、ステージングに追加されておらず、コミットもされていない状態になります。

# 「bugfix.patch」というパッチファイルがある場合
git apply bugfix.patch

このコマンドはパッチファイルの中のすべての内容が適用可能な場合に実行され、適用する際に一部のファイルのみにエラーがあった場合でも全てのファイルに何も適用しないという動作をします。（後述の--rejectオプションを使うことで、パッチ適用可能なファイルは適用させることが可能です。）

パッチファイルの作成方法

パッチファイルの作成方法はいくつかありますが、中でもよく使われる2つのコマンドをご紹介します。

• git diff

  このコマンドはワーキングツリーで作業した際に差分を確認することができるコマンドですが、その出力をそのままファイルに格納することでパッチファイルとして扱うことができます。パッチファイルはテキスト形式ですが、拡張子は「.patch」を用いることが一般的です。git diffコマンドについてはこちらの記事を参考にしてください。

  https://envader.plus/article/245

  # git diffの出力を「bugfix.patch」ファイルに格納
  git diff > bugfix.patch

• git format-patch

  このコマンドはgit diffと異なり、既に作成したコミットからパッチファイルを作成することができます。コマンドに続いて数を指定することで、パッチファイルを作成する過去のコミットの数を指定します。-1であれば最新のコミットから1つのパッチファイルを、-2であれば2つのコミットからそれぞれ1つずつ2つのパッチファイルを作成します。

  ファイル名は「連番-コミットメッセージ.patch」のようになります。

  # コミットメッセージが「fix」だった場合、「0001-fix.patch」というパッチファイルが作成される
  git format-patch -1

  git diff コマンドと違う点は、コミットの情報がパッチファイルに含まれていることです。git applyコマンドでパッチファイルを適用する際はワーキングツリーに変更を適用するだけですが、git amというコマンドを使用することで、変更をコミットとして取り込むこともできます。その場合、そのパッチファイル作成時に参照されたコミットの情報、作成者やタイムスタンプ、コミットメッセージがそのまま新たなコミットとして適用されます。

  git am 0001-fix.patch

オプション

git applyコマンドの主なオプションには以下のようなものがあります。

• --reverse
• --reject
• --stat
• --check

--reverse

git applyコマンドを適用した後、その適用した変更を取り消すことができるオプションです。ここでは、「bugfix.patch」というパッチファイルを作成済みだとします。

# パッチファイルを適用する
git apply bugfix.patch

# 適用した変更を取り消す
git apply --reverse bugfix.patch

--reject

このオプションを用いることで、パッチファイル適用時にエラーが出て適用できないファイルがある場合でも、適用可能なファイルには変更が適用されます。適用できなかったファイルとそのパッチの詳細情報は「適用に失敗したファイル名.rej」というファイルに格納することができます。

# main.goファイルにパッチが適用できなかった場合、「main.go.rej」というファイルが作成される
git apply --reject bugfix.patch

--stat

パッチファイルの適用前に、変更の概要を表示することができます。そのパッチファイルが何のファイルをどの程度変更するのかを確認できます。以下は、「main.go」ファイルの1行のみを変更するパッチファイルをオプション付きで実行した場合の例です。

git apply --stat bugfix.patch

 main.go |    1 +
 1 file changed, 1 insertions(+)

--check

パッチファイルを適用する前に、エラーが出ないかどうかを確かめることができるオプションです。エラーがある場合はそれが表示され、問題なく実行できる場合は何も表示されず適用もされません。

git apply --check bugfix.patch

まとめ

git applyコマンドは、パッチファイルをワーキングツリーに適用するためのツールです。git diffやgit format-patchで作成したパッチファイルを適用することができ、オフライン環境での作業やOSSプロジェクトへのコントリビュートなどで活躍します。今ではプルリクエストによる変更の確認や適用が主流になっていますが、上記のように有用な場面は依然として存在します。普段の開発ではそこまで使うことが多いコマンドではないかもしれませんが、git applyコマンドを理解し適切に使いこなすことで、ぜひ様々な状況に対応できるエンジニアになってください。