シェルスクリプトでGitフックを設計する方法｜pre-commit・pre-pushへのチェック組み込みとチームへの配布パターン

この記事のポイント

・Gitフックはexit 0で処理続行・非0でブロックというルールで動作するシェルスクリプトである
・pre-commitでgit diff --staged --name-onlyを使い変更ファイルにshellcheckを実行できる
・core.hooksPathでバージョン管理対象のディレクトリへ向けるとチームへ配布できる
・shellcheckが見つからない環境ではexit 0でスキップする設計にするのが実務上の鉄則

# .git/hooks/ の内容を確認する
ls .git/hooks/
# 出力例（環境により異なります）
applypatch-msg.sample  commit-msg.sample        fsmonitor-watchman.sample
pre-applypatch.sample  pre-commit.sample        pre-merge-commit.sample
pre-push.sample        pre-rebase.sample        prepare-commit-msg.sample
update.sample

# pre-commitフックのひな型を作成する
cat > .git/hooks/pre-commit << 'HOOKEOF'
#!/bin/bash
set -euo pipefail
echo "[pre-commit] フックが実行されました"
exit 0
HOOKEOF

# 実行権限を付与する
chmod +x .git/hooks/pre-commit

# 設定を確認する（出力例）
ls -la .git/hooks/pre-commit
-rwxr-xr-x 1 user user 72 Nov  7 17:30 .git/hooks/pre-commit

# ステージングされたファイルを取得する（追加・コピー・変更のみ）
STAGED_FILES=$(git diff --staged --name-only --diff-filter=ACM 2>/dev/null)

# 1ファイルずつ処理する
while IFS= read -r file; do
    echo "対象: $file"
done <<< "$STAGED_FILES"

#!/bin/bash
set -euo pipefail

# shellcheckが使えるか確認する（未インストール環境ではスキップする）
if ! command -v shellcheck &>/dev/null; then
    echo "[pre-commit] shellcheckが見つかりません。チェックをスキップします。"
    exit 0
fi

# ステージングされたファイルを取得する
STAGED_FILES=$(git diff --staged --name-only --diff-filter=ACM 2>/dev/null)

FAILED=0
while IFS= read -r file; do
    [[ -z "$file" ]] && continue
    [[ ! -f "$file" ]] && continue

    # .shファイル、またはshebangにshが含まれるファイルを対象にする
    if [[ "$file" == *.sh ]] || head -1 "$file" 2>/dev/null | grep -qE '^#!.*(ba)?sh'; then
        echo "[pre-commit] shellcheck: $file"
        if ! shellcheck "$file"; then
            FAILED=1
        fi
    fi
done <<< "$STAGED_FILES"

if [[ $FAILED -ne 0 ]]; then
    echo "[pre-commit] shellcheckでエラーが見つかりました。修正してからコミットしてください。"
    exit 1
fi

exit 0

#!/bin/bash
# 引数: $1=リモート名（例: origin）、$2=リモートURL
REMOTE="$1"
URL="$2"

# 標準入力からプッシュ対象を受け取る
# フォーマット: <ローカルref> <ローカルSHA> <リモートref> <リモートSHA>
while read -r local_ref local_sha remote_ref remote_sha; do
    echo "プッシュ対象: $local_ref -> $remote_ref"
done

#!/bin/bash
set -euo pipefail

REMOTE="$1"
URL="$2"

# プッシュ先のブランチを確認する
while read -r local_ref local_sha remote_ref remote_sha; do
    if [[ "$remote_ref" == refs/heads/main ]]; then
        echo "[pre-push] mainブランチへのプッシュ前にテストを実行します..."
        if [[ -f "./run-tests.sh" ]]; then
            if ! bash ./run-tests.sh; then
                echo "[pre-push] テストが失敗しました。プッシュを中断します。"
                exit 1
            fi
            echo "[pre-push] テストが通過しました。"
        fi
    fi
done

exit 0

# リポジトリのルートに.githooksディレクトリを作成する
mkdir -p .githooks

# .git/hooks/のフックを.githooksへ移動する
mv .git/hooks/pre-commit .githooks/pre-commit
mv .git/hooks/pre-push  .githooks/pre-push

# 実行権限が付いているか確認する（出力例）
ls -la .githooks/
-rwxr-xr-x 1 user user 1234 Nov  7 17:30 pre-commit
-rwxr-xr-x 1 user user  567 Nov  7 17:30 pre-push

# gitの管理対象に追加する
git add .githooks/
git commit -m "chore: Gitフックを.githooksへ移動"

#!/bin/bash
# setup.sh（リポジトリルートに置く）
set -euo pipefail

HOOKS_DIR=".githooks"

if [[ ! -d "$HOOKS_DIR" ]]; then
    echo "エラー: $HOOKS_DIR が見つかりません"
    exit 1
fi

# core.hooksPathをローカルgit設定に書き込む
git config --local core.hooksPath "$HOOKS_DIR"
echo "Gitフックのセットアップが完了しました。"
echo "フックディレクトリ: $(git config core.hooksPath)"

# core.hooksPathの設定を確認する（出力例）
git config --local core.hooksPath
.githooks

# フックの実行権限を確認する（出力例）
ls -la .githooks/
-rwxr-xr-x 1 user user 1234  pre-commit
-rwxr-xr-x 1 user user  567  pre-push

# 1. 実行権限を確認する
ls -la .git/hooks/pre-commit
# -rwxr-xr-x なら権限OK。-rw-r--r-- なら chmod +x で付与する

# 2. core.hooksPathの設定を確認する
git config --local core.hooksPath
# .githooksが返れば設定済み。空なら setup.sh を再実行する

# 3. shebangを確認する
head -1 .githooks/pre-commit
# #!/bin/bash のような正しいshebangが必要

# フックをスキップしてコミットする（緊急時のみ使用する）
git commit --no-verify -m "hotfix: 緊急対応"

# 改行コードをLFに変換する
dos2unix .githooks/pre-commit

# 改行コードを確認する（出力例）
file .githooks/pre-commit
.githooks/pre-commit: Bourne-Again shell script, ASCII text executable