テーマを git で書き出す仕組みを、新しいサイトにも追加しました。
すでにあるサイトのフックをコピーして、書き出し先だけを置き換えて使いました。
すると push のあと、新しいサイトのテーマのフォルダに、元のサイトのテーマが書き出されてしまいました。
すぐにテーマを書き出し直して戻しましたが、しばらくのあいだ、ページがエラー(500)になりました。
同じことをパソコンの中で起こしてみて、残ったファイルの探し方と、コピーしたあとに確認する 5 つの手順を決めました。
テーマを書き出す仕組み
管理しているサイトでは、テーマを git で管理しています。
サーバーに bare リポジトリ(作業用のファイルを持たない、受け取る専用のリポジトリ)を置き、そこに push します。
push を受け取ると、リポジトリの hooks/post-receive が動き、テーマのフォルダにファイルを書き出します。
よく使われる形は、次のようなものです。
#!/bin/sh
# site-a: push された master をテーマのフォルダに書き出す
GIT_DIR="/home/(ユーザー名)/git/site-a.git"
TARGET="/home/(ユーザー名)/site-a.example.com/public_html/wp-content/themes/(テーマのフォルダ)"
BRANCH="master"
while read oldrev newrev ref
do
if [ "$ref" = "refs/heads/$BRANCH" ]; then
echo "site-a: deploy $BRANCH to $TARGET"
git --work-tree="$TARGET" --git-dir="$GIT_DIR" checkout -f "$BRANCH"
echo "site-a: done"
fi
done
| 書き方 | 役目 |
|---|---|
GIT_DIR |
どのリポジトリから書き出すか(bare リポジトリの場所) |
TARGET |
どこに書き出すか(テーマのフォルダ) |
BRANCH |
書き出すブランチ |
while read oldrev newrev ref |
push されたブランチを 1 つずつ受け取る |
[ "$ref" = "refs/heads/$BRANCH" ] |
master への push のときだけ書き出す |
git --work-tree --git-dir checkout -f |
GIT_DIR のリポジトリの内容を、TARGET のフォルダに書き出す。-f は、フォルダにある同じ名前のファイルを上書きする |
echo |
push した側の画面に、remote: の付いたメッセージとして出る |
大事なのは、1 つのサイトに対して、リポジトリの名前(site-a.git)とサイトのフォルダ(site-a.example.com)の、2 つの名前が出てくることです。
起きたこと
新しく 2 つのサイトに、同じ仕組みを追加することになりました。
すでにあるサイトのフックをコピーして、書き出し先(TARGET)のサイトのフォルダの名前だけを、sed で置き換えました。
cd /home/(ユーザー名)/git sed 's/site-a\.example\.com/site-b.example.com/g' site-a.git/hooks/post-receive > site-b.git/hooks/post-receive chmod +x site-b.git/hooks/post-receive
このとき、GIT_DIR の行は、元のサイトのリポジトリ(site-a.git)のままでした。
リポジトリの名前とサイトのフォルダの名前が違うので、sed の置き換えにかからなかったのです。
この状態で push すると、push したリポジトリ(site-b.git)ではなく、site-a.git の内容が、新しいサイトのテーマのフォルダに書き出されます。
2 つのサイトとも、元のサイトのテーマが書き出され、ページがエラー(500)になりました。
すぐに正しいテーマを書き出し直して戻しました。
あとで見直すと、push のログの echo のメッセージにも、元のサイトの名前が出ていました。
ログのメッセージを見ていれば、ページを開く前に気づけたことになります。
ローカルで同じことを試した
何が起きるのかをはっきりさせるため、パソコンの中(Windows の Git Bash・git 2.49)で同じ形を作って試しました。
外のサーバーには push していません。
試しのフォルダの中に、次のものを作りました。
| 作ったもの | 内容 |
|---|---|
git/site-a.git・git/site-b.git |
bare リポジトリ 2 つ |
| site-a のテーマ | style.css(Theme Name: site-a theme)・functions.php・inc-a.php |
| site-b のテーマ | style.css(Theme Name: site-b theme)・functions.php・inc-b.php |
| 書き出し先 | site-a.example.com/…/my-theme・site-b.example.com/…/my-theme |
site-b の書き出し先には、先に site-b のテーマを置いておきました。
フックのパスは、先頭にテスト用のフォルダ($ROOT)を付けています。
ログの中のテスト用のフォルダは、ROOT と書き換えて載せています。
1. 書き出し先だけを置き換えたフック
sed で置き換えたあと、元の名前(site-a)で grep しました。
grep -n 'site-a' site-b.git/hooks/post-receive
2:# site-a: push された master をテーマのフォルダに書き出す 4:GIT_DIR="$ROOT/home/user/git/site-a.git" 11: echo "site-a: deploy $BRANCH to $TARGET" 13: echo "site-a: done"
GIT_DIR の行と、echo のメッセージに、site-a が残っていました。
このまま site-b に push すると、ログは次のようになりました。
remote: site-a: deploy master to ROOT/home/user/site-b.example.com/public_html/wp-content/themes/my-theme remote: Already on 'master' remote: site-a: done
書き出し先は site-b のフォルダですが、メッセージは site-a です。
このメッセージの食い違いが、おかしいと気づける手がかりになります。
2. 置き換える値を全部挙げて置き換えたフック
次に、置き換える値を全部挙げてから置き換えました。
| 置き換える値 | 元 | 新しいサイト |
|---|---|---|
リポジトリの名前(GIT_DIR) |
site-a.git |
site-b.git |
サイトのフォルダ(TARGET) |
site-a.example.com |
site-b.example.com |
| メッセージとコメント | site-a: |
site-b: |
cd /home/(ユーザー名)/git
sed -e 's/site-a\.example\.com/site-b.example.com/g' \
-e 's/site-a\.git/site-b.git/g' \
-e 's/site-a:/site-b:/g' \
site-a.git/hooks/post-receive > site-b.git/hooks/post-receive
chmod +x site-b.git/hooks/post-receive
# 元の名前が残っていないか(0 件なら何も出ない)
grep -n 'site-a' site-b.git/hooks/post-receive
grep -c 'site-a' site-b.git/hooks/post-receive
# 全部の行を見る
cat site-b.git/hooks/post-receive
| 書き方 | 役目 |
|---|---|
sed -e … -e … |
置き換えをいくつも並べて、一度に行う |
site-a\.example\.com |
「.」を、どの文字にも合う記号ではなく、ただの「.」として探す |
grep -n 'site-a' |
元の名前が残っている行を、行の番号つきで出す |
grep -c 'site-a' |
残っている行の数を出す。0 なら残っていない |
cat |
フックの全部の行を出して、目で見る |
試しでは、grep -n は何も出ず、grep -c は 0 でした。
cat で全部の行を見て、GIT_DIR・TARGET・メッセージのどれもが site-b になっていることを確認してから、push しました。
remote: site-b: deploy master to ROOT/home/user/site-b.example.com/public_html/wp-content/themes/my-theme remote: Already on 'master' remote: site-b: done
書き出し先に出たもの
| いつ | 結果 |
|---|---|
| push の前 | site-b のテーマのフォルダ:functions.php・inc-b.php・style.css style.css の Theme Name:site-b theme push のログのメッセージ:- |
| 1. GIT_DIR が残ったフック | site-b のテーマのフォルダ:functions.php・inc-a.php・inc-b.php・style.css style.css の Theme Name:site-a theme push のログのメッセージ:site-a: deploy … |
| 2. 全部置き換えたフック | site-b のテーマのフォルダ:functions.php・inc-a.php・inc-b.php・style.css style.css の Theme Name:site-b theme push のログのメッセージ:site-b: deploy … |
1 では、style.css と functions.php が site-a のものに上書きされ、site-a にしかない inc-a.php が増えました。
site-b にしかない inc-b.php は、消されずに残りました。
2 つのテーマのファイルが混ざった状態です。
元のサイトのテーマが、別のサイトの上で動くので、そのサイトに合わない処理が動き、エラーになることがあります。
site-a のテーマのフォルダは、1 でも 2 でも変わりませんでした。
書き出し直しても残るファイル
2 で正しく書き出したあとも、inc-a.php は残っていました。
checkout -f は、リポジトリにあるファイルを上書きしますが、リポジトリにないファイルは消しません。
残ったファイルは、次のように探せます。
git --work-tree="(テーマのフォルダ)" --git-dir=site-b.git status --short git --work-tree="(テーマのフォルダ)" --git-dir=site-b.git clean -n
?? inc-a.php Would remove inc-a.php
status --short の ?? は、リポジトリにないファイルです。
clean -n は、消すファイルの一覧を出すだけで、何も消しません。
テーマのフォルダには、git で管理していないファイルを、わざと置いていることもあります。
一覧を見て、元のサイトから来たファイルだけを、確認してから消します。
コピーしたあとに確認する手順
この件のあと、フックをコピーするときは、次の順で確認することにしました。
- 置き換える値を、先に全部挙げる(リポジトリの名前・サイトのフォルダ・メッセージ)
- sed で置き換えたら、元の名前で grep して、0 件になることを確認する
- cat で全部の行を見る。とくに
GIT_DIRとTARGETの 2 行が、同じサイトを指しているか echoのメッセージにサイトの名前を含めておき、push のログで、どのサイトに書き出したかを見る- push の直後に、トップと記事を 1 本、ブラウザーか curl で開く
5 は、curl なら次のようにまとめて見られます。
for u in "https://site-b.example.com/" "https://site-b.example.com/archives/123"; do
curl -s -o /dev/null -w '%{http_code} ' "$u"
echo "$u"
done
| 書き方 | 役目 |
|---|---|
-s |
進捗の表示を出さない |
-o /dev/null |
ページの本文は捨てる |
-w '%{http_code} ' |
HTTP のステータス(200・500 など)だけを出す |
作業環境のこのサイトで、トップと記事 1 本に同じ形で流すと、どちらも 200 でした。
500 が出たら、すぐにテーマを書き出し直します。
気をつけること
- 試しでは、git が「LF will be replaced by CRLF」という注意を出しました。Windows で試したための注意で、書き出しの結果には関係ありません
- サーバーでの手順(SSH で入る・権限)は、サーバーごとに違います。この記事の試しは、パソコンの中だけで行いました
まとめ
すでに動いているほかのサイトのフックも cat で開き、GIT_DIR と TARGET が同じサイトを指しているかを見ます。echo にサイトの名前が入っていないフックには、名前を足します。
参考
- githooks:post-receive(git-scm.com)
- git-checkout(git-scm.com)
- git-clean(git-scm.com)
- Git フック(Pro Git・git-scm.com)
くわしい手順は、特集「エックスサーバーで Git の環境を作る」にまとめています。

