結論
-
git commitコマンドを実行しようとする -
pre-commitが実行される -
prepare-commit-msgが実行される - コミットメッセージ入力ができるようになる
-
commit-msgが実行される - コミットが実行される
-
post-commitが実行される
はじめに
背景
Git Hookという便利な機能があるのに使いこなせなかった新卒情弱エンジニアはGit Hookを使ってみようと思った。
思いの外いろいろなところで処理を行うことができるのでここでまとめる。Gitの用語や使い方は猿でもわかるレベルでまとめられているのでその知識があると仮定してこの記事を書く。
そもそもGit Hookとは
Gitのアクションごとにクライアントサイドやサーバサイドでスクリプトを実行することができる。その機能のこと。
この記事の目的
Git Hook未経験者がどのタイミングでフックを実行できるのか知ることができる。
事前準備
以降の内容を実際に実行するため、新規に任意名のフォルダを作成し、その中でgit initコマンドを実行する。すると任意名フォルダ/.git/hooksが生成されているはずなので確認する(.gitフォルダは隠しフォルダのためls -aで確認できる)
コミットワークフローフック
コミットワークフローフックには以下の4種類がある。
pre-commitprepare-commit-msgcommit-msgpost-commit
echoコマンドを用いてどのようなタイミングで発生しているのか確かめてみる。
まず、git add、git commitしてメッセージを入力する際に:shしてターミナルに戻った時の出力。
すでにprepare-commit-msgまで進んでいることがわかる。次に、メッセージを入力してコミットした時の出力。
post-commitまで進んでいる。では、実際のコミットはどの時点で行われているのだろうか。commit-msgファイルの末尾にexit 1を追記して再度検証してみる。test.txtをステージングに追加し、コミットメッセージを入力した後、git statusで状態を確認したものがこれ。
commit-msgは行なっているにも関わらず、そこで1が返された結果コミットはされていないことがわかる。
最後にcommit-msgファイルの代わりにpost-commitファイルの末尾にexit 1を追記（commit-msg内のexit 1は消去）してコミットした結果は以下。
きちんとコミットされていることがわかる。よってコミットの流れと各フックのタイミングは以下。
-
git commitコマンドを実行しようとする -
pre-commitが実行される -
prepare-commit-msgが実行される - コミットメッセージ入力ができるようになる
-
commit-msgが実行される - コミットが実行される
-
post-commitが実行される