git rebaseのインタラクティブ操作

Tech

Git Rebase Interactiveによるコミット履歴の整理と安全なDevOps運用

git rebase --interactiveはコミット履歴を整理・改変する強力な機能である。本稿では、その基本的な操作とDevOps実践における安全な利用方法を解説する。

要件と前提

git rebase --interactiveは、ブランチの基点を変更し、コミットの編集、結合、並べ替え、削除を行う機能である。これにより、Git履歴をクリーンで理解しやすい状態に保つことが可能となる。

前提として、以下のツールがインストールされている環境を想定する。 – Git: バージョン2.x以降 – bash: バージョン4.x以降 – jq: JSONプロセッサ – curl: HTTPクライアント – systemd: サービス管理システム（Linux環境）

操作は通常ユーザー権限で行うが、systemd unit/timerのインストールにはroot権限が必要となる場合がある。ただし、実行は特定ユーザーに限定する最小権限の原則を適用する。

実装

安全なBashスクリプトとgit rebase --interactiveの実行例を示す。

安全なBashスクリプトのフレームワーク

#!/usr/bin/env bash

# スクリプトの安全な実行設定
set -euo pipefail # エラー時に即座に終了、未定義変数を使用しない、パイプのエラーを検出
IFS=$'\n\t'      # ワード分割にスペース、タブ、改行のみを使用

# 一時ディレクトリの作成と終了時のクリーンアップ
TMP_DIR=$(mktemp -d)
trap 'echo "Cleaning up temporary directory: $TMP_DIR"; rm -rf "$TMP_DIR"' EXIT # スクリプト終了時に一時ディレクトリを削除

log_info() {
    echo "$(date '+%Y-%m-%d %H:%M:%S') [INFO] $*"
}

log_error() {
    echo "$(date '+%Y-%m-%d %H:%M:%S') [ERROR] $*" >&2
    exit 1
}

main() {
    log_info "スクリプト実行開始"

    # ここにメイン処理を記述
    # 例: git rebase interactiveのデモンストレーション
    # 例: jqとcurlの使用例

    log_info "スクリプト実行終了"
}

main "$@"

Gitリポジトリの準備とRebase Interactiveの実行

まず、デモ用のGitリポジトリを作成し、いくつかのコミットを行う。

#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'

REPO_DIR="$TMP_DIR/my_project" # TMP_DIRは上記フレームワークから継承
mkdir -p "$REPO_DIR"
cd "$REPO_DIR"

git init
git config user.email "devops@example.com"
git config user.name "DevOps Engineer"

# 初期コミット
echo "Initial content" > file1.txt
git add file1.txt
git commit -m "feat: Initial project setup"

# コミットA
echo "Feature A" > file2.txt
git add file2.txt
git commit -m "feat: Implement feature A"

# コミットB (typoを含むとする)
echo "Fix typo" >> file1.txt
git add file1.txt
git commit -m "fix: Typo in initial setup"

# コミットC
echo "Feature C" > file3.txt
git add file3.txt
git commit -m "feat: Add feature C"

# コミットD (コミットBに関連する修正)
echo "Further fix for typo" >> file1.txt
git add file1.txt
git commit -m "fix: Refine typo fix"

log_info "現在のコミット履歴:"
git log --oneline --graph --all

# interactive rebaseの実行
# 直近5つのコミットを対象にする
log_info "git rebase -i HEAD~5 を実行します。エディタが起動します。"
log_info "エディタで以下の変更を試行してください:"
log_info "  1. 'feat: Initial project setup' を 'reword' でコミットメッセージ修正"
log_info "  2. 'fix: Typo in initial setup' と 'fix: Refine typo fix' を 'fixup' で結合"
log_info "  3. 'feat: Add feature C' の位置を 'feat: Implement feature A' の直後に移動"

# エディタが起動する
# export GIT_EDITOR="vi" などでエディタを指定可能。今回はデフォルトエディタを使用
git rebase -i HEAD~5

git rebase -i HEAD~5実行後、エディタが起動する。以下のような内容が表示される。

pick <hash_initial> feat: Initial project setup
pick <hash_feat_A> feat: Implement feature A
pick <hash_fix_B> fix: Typo in initial setup
pick <hash_feat_C> feat: Add feature C
pick <hash_fix_D> fix: Refine typo fix

# Rebase <hash>..HEAD onto <hash> (<num> commands)
# ...
# Commands:
# p, pick <commit> = use commit
# r, reword <commit> = use commit, but edit the commit message
# e, edit <commit> = use commit, but stop for amending
# s, squash <commit> = use commit, but meld into previous commit
# f, fixup <commit> = like "squash", but discard this commit's log message
# x, exec <command> = run command (the rest of the line) for each commit
# b, break = stop here (continue rebase later with 'git rebase --continue')
# d, drop <commit> = remove commit
# l, label <label> = label current HEAD with a name
# t, reset <label> = reset HEAD to a label
# m, merge [-C <commit> | -c <commit>] <label> | <id> = commit the current merge changes and update the provided origin ref (i.e. <id> or <label>)
#
# These lines can be re-ordered; they are executed from top to bottom.
# ...

上記の指示に従い、例えば以下のように編集する。

reword <hash_initial> feat: Initial project setup
pick <hash_feat_A> feat: Implement feature A
pick <hash_feat_C> feat: Add feature C # CをAの直後に移動
fixup <hash_fix_B> fix: Typo in initial setup # DをBに結合するため、先にBを記述
fixup <hash_fix_D> fix: Refine typo fix

保存してエディタを閉じると、rebase処理が進行する。rewordを指定したコミットで再度エディタが起動するので、メッセージを「feat: Initial project setup with basic files」のように修正し、保存する。

jq を用いたJSON処理

GitログをJSON形式で取得し、jqで整形する。

#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'

REPO_PATH="./" # 適切なGitリポジトリのパスを指定
if [[ -d "$REPO_PATH/.git" ]]; then
    cd "$REPO_PATH"
else
    log_error "指定されたパスにGitリポジトリが見つかりません: $REPO_PATH"
fi

log_info "GitログをJSON形式で取得し、jqで整形します。"
git log --pretty=format:'{"hash":"%H", "author":"%an", "date":"%ad", "message":"%s"},' --no-merges | \
    sed '$ s/,$//' | \
    jq -s '.' > "$TMP_DIR/git_log.json"

log_info "生成されたJSONファイル: $TMP_DIR/git_log.json"
cat "$TMP_DIR/git_log.json" | jq .

curl のTLS/再試行/バックオフ例

外部APIへの安全なリクエスト例。

#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'

API_ENDPOINT="https://api.github.com/repos/octocat/Spoon-Knife" # テスト用APIエンドポイント
MAX_RETRIES=5
RETRY_DELAY_SEC=3

log_info "curl を用いてAPIエンドポイントに安全にリクエストを送信します。"
log_info "エンドポイント: $API_ENDPOINT"

if ! curl -s --retry "$MAX_RETRIES" \
              --retry-delay "$RETRY_DELAY_SEC" \
              --retry-max-time $((MAX_RETRIES * RETRY_DELAY_SEC * 2)) \
              -Ssv \
              --tlsv1.2 \
              "$API_ENDPOINT" > "$TMP_DIR/api_response.json" 2>&1; then
    log_error "APIリクエストが失敗しました。詳細は $TMP_DIR/api_response.json を確認してください。"
fi

log_info "APIレスポンスを $TMP_DIR/api_response.json に保存しました。"
jq . < "$TMP_DIR/api_response.json"

検証

rebase後のコミット履歴が意図通りに整理されているか確認する。

log_info "Rebase後のコミット履歴:"
git log --oneline --graph --all

git logの出力で、コミットメッセージの変更、コミットの結合、順序の変更が反映されていることを確認する。 jqとcurlの出力は、それぞれのコマンドが期待通りに動作し、JSONデータが取得・整形されていることを目視または自動テストで確認する。

運用

DevOps環境における定期的なGitリポジトリの健全性チェックや情報収集を想定し、systemd unit/timerを用いた自動化の例を示す。これにより、上記jqを用いたログ取得などを定期的に実行できる。

systemd unit/timerの例

ここでは、ユーザー単位のsystemdサービスとして、jqでGitログを収集するスクリプトを定期実行する例を示す。これにより、root権限を必要とせずに自動化が可能となる。

1. スクリプトの準備 (/home/user/bin/collect_git_logs.sh)

#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'

# Gitリポジトリのパス。適切なパスに変更する
REPO_PATH="/path/to/your/git_repository"
OUTPUT_DIR="/home/user/logs/git"
mkdir -p "$OUTPUT_DIR"

LOG_FILE="$OUTPUT_DIR/git_log_$(date +%Y%m%d%H%M%S).json"

if [[ -d "$REPO_PATH/.git" ]]; then
    cd "$REPO_PATH"
else
    echo "$(date '+%Y-%m-%d %H:%M:%S') [ERROR] Gitリポジトリが見つかりません: $REPO_PATH" >&2
    exit 1
fi

echo "$(date '+%Y-%m-%d %H:%M:%S') [INFO] GitログをJSON形式で収集開始。"
git log --pretty=format:'{"hash":"%H", "author":"%an", "date":"%ad", "message":"%s"},' --no-merges | \
    sed '$ s/,$//' | \
    jq -s '.' > "$LOG_FILE"

echo "$(date '+%Y-%m-%d %H:%M:%S') [INFO] Gitログを $LOG_FILE に保存しました。"

このスクリプトに実行権限を与える: chmod +x /home/user/bin/collect_git_logs.sh

2. Unitファイルの作成 (~/.config/systemd/user/git-log-collector.service)

[Unit]
Description=Collect Git logs in JSON format
Documentation=https://example.com/git-log-collector-doc

[Service]
Type=oneshot
ExecStart=/home/user/bin/collect_git_logs.sh
User=%i
Group=%i
WorkingDirectory=/home/user
StandardOutput=journal
StandardError=journal
Restart=on-failure
RestartSec=5

[Install]
WantedBy=default.target

3. Timerファイルの作成 (~/.config/systemd/user/git-log-collector.timer)

[Unit]
Description=Run Git log collector every day

[Timer]
OnCalendar=daily
Persistent=true
# Unit=git-log-collector.service (default if not specified, same name as timer but with .service suffix)

[Install]
WantedBy=timers.target

4. systemdサービスの有効化と起動

ユーザーセッションでsystemdサービスを管理するため、以下を実行する。

systemctl --user daemon-reload
systemctl --user enable git-log-collector.timer
systemctl --user start git-log-collector.timer

5. ログ確認

journalctl --user -u git-log-collector.service

root権限の扱いと権限分離の注意点

systemd –userサービスは、ログイン中のユーザーの権限で実行されるため、root権限を必要としない。これにより、最小権限の原則が適用され、セキュリティリスクを低減できる。しかし、スクリプト内でSSHキーやAPIトークンなどの機密情報を扱う場合は、適切な権限設定（例: ~/.sshディレクトリのパーミッション制限）とSecrets Managementソリューション（例: HashiCorp Vault）の利用が必須となる。

トラブルシュート

Rebase中のコンフリクト

git rebase --interactive中に同じファイルの異なる箇所が変更されている場合、コンフリクトが発生することがある。

# コンフリクト発生時のメッセージ例
# CONFLICT (content): Merge conflict in file1.txt
# error: could not apply <hash>... <commit message>

対処法: 1. git statusでコンフリクトファイルを確認する。 2. コンフリクトマーカー（<<<<<<<, =======, >>>>>>>）を修正し、ファイルを保存する。 3. git add <conflicted_file>で解決したファイルをステージングする。 4. git rebase --continueでrebase処理を続行する。 5. rebaseを中止したい場合は、git rebase --abortを実行し、元の状態に戻す。

履歴の消失

rebase操作は履歴を改変するため、意図しない変更やコミットの消失が発生する可能性がある。

対処法: git reflogコマンドは、HEADが指したすべての履歴（コミット、rebase、resetなど）を記録している。

git reflog

出力例:

<hash> HEAD@{0}: rebase -i (finish): returning to refs/heads/main
<hash> HEAD@{1}: rebase -i (start): checkout HEAD~5
<hash> HEAD@{2}: commit: feat: Add feature D
...

元の状態に戻したい場合は、git reset --hard HEAD@{n} のように、reflogの特定の時点を指定して復旧する。

強制プッシュ (git push --force-with-lease) の注意点

rebaseでローカル履歴が変更された場合、リモートリポジトリとの履歴が異なるため、通常のgit pushは拒否される。この際、git push --forceまたはgit push --force-with-leaseを使用する必要がある。

  • git push --force: リモートの履歴を無条件に上書きする。他の開発者が同じブランチにプッシュしている場合、その変更を破壊する可能性がある。
  • git push --force-with-lease: リモートのブランチがローカルで最後にフェッチした時と変更されていない場合にのみ強制プッシュを行う。より安全な選択肢である。

運用上の注意: 共有ブランチ（mainやdevelopなど）では、git rebaseとそれに続く強制プッシュは極力避けるべきである。個人のフィーチャーブランチやトピックブランチで、マージ前に履歴をクリーンアップする目的で使用するのが一般的である。

まとめ

git rebase --interactiveは、煩雑なコミット履歴を整理し、開発プロセスを効率化するための強力なツールである。しかし、履歴を改変する特性上、その利用には慎重さが求められる。本稿では、安全なbashスクリプトのベストプラクティス、jqとcurlのDevOps運用における活用例、そしてsystemdを用いたタスクの自動化と権限分離の重要性を示した。これらの技術を適切に組み合わせることで、クリーンなGit履歴を維持しつつ、堅牢で効率的なDevOps環境を構築・運用することが可能となる。共有ブランチでの強制プッシュの危険性を常に意識し、トラブル時にはgit reflogを活用するなど、リカバリーパスも熟知しておくことが肝要である。

graph TD
    A["開発開始"] --> B("フィーチャーブランチ作成")
    B --> C1("コミット1: feat A")
    C1 --> C2("コミット2: fix B")
    C2 --> C3("コミット3: feat C")
    C3 --> D{"git rebase -i main"}
    D --エディタで操作--> E["pick, reword, squash, drop, reorder"]
    E --> F{"Rebase処理実行"}
    F --コンフリクト発生?--> G["コンフリクト解決 (git add/rebase --continue)"]
    G --Yes--> F
    F --No--> H["履歴整理済みブランチ"]
    H --> I("レビュー/テスト")
    I --> J{"マージ可能?"}
    J --Yes--> K["mainブランチへマージ"]
    J --No--> C1
    K --> L["デプロイ"]
ライセンス：本記事のテキスト/コードは特記なき限り CC BY 4.0 です。引用の際は出典URL（本ページ）を明記してください。
利用ポリシー もご参照ください。

コメント

タイトルとURLをコピーしました