正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

チュートリアル: Gitコミットメッセージを更新する

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

ブランチにいくつかのコミットを行った後、1つ以上のコミットメッセージを更新する必要があることに気付く場合があります。タイプミスを見つけた場合や、自動化によって、コミットメッセージがプロジェクトのコミットメッセージガイドラインに一部準拠していないことが警告された場合などです。

コマンドラインインターフェース（CLI）からGitを使用することに不慣れな場合、メッセージの更新は難しい場合があります。ただし、今までGitLab UIでのみ作業していた場合でも、心配する必要はありません。次の手順に従ってCLIを使用できます。

このチュートリアルでは、次の2つの場合にコミットメッセージを書き換える方法について説明します:

  • GitLab UIでのみ作業している場合は、手順1から開始します。
  • すでにローカルでリポジトリをクローンしている場合は、手順1を省略して手順2に進むことができます。

任意の数のコミットメッセージを書き換えるには:

  1. プロジェクトのリポジトリをローカルマシンにクローンします。
  2. ブランチをフェッチしてローカルでチェックアウトします。
  3. コミットメッセージを更新します。
  4. 変更をGitLabにプッシュします。

はじめる前

以下が必要です:

  • 更新するコミットを含んでいるGitブランチがあるGitLabプロジェクト。
  • Gitがローカルマシンにインストールされていること。
  • ローカルマシンのコマンドラインインターフェース（CLI）へのアクセス。macOSでは、ターミナルを使用できます。Windowsでは、PowerShellを使用できます。Linuxユーザーはおそらく、システムのCLIをよくご存じでしょう。
  • システムのデフォルトのエディタに精通していること。このチュートリアルでは、エディタがVimであることを前提としていますが、どのテキストエディタでも動作するはずです。Vimに慣れていない場合は、Getting started with Vim（Vimの使用を開始する）の手順1–2を参照してください。このチュートリアルの後半で使用するすべてのコマンドについて説明されています。
  • コミットメッセージを上書きする権限。同じブランチで複数の人と共同作業している場合は、コミットを更新しても問題ないことを最初に他の作業者に確認する必要があります。一部の組織では、コミットの書き換えは破壊的な変更と見なされるため、禁止されている場合があります。

最後の手順でコミットメッセージを上書きするには、GitLabで認証する必要があります。GitLabアカウントでユーザー名とパスワードによる基本的な認証を使用している場合は、2要素認証（2FA）を無効にして、CLIから認証を行う必要があります。または、SSHキーを使用してGitLabで認証することもできます。

リポジトリをローカルマシンにクローンする

最初の手順は、ローカルマシンでリポジトリのクローンを取得することです:

  1. GitLabで、プロジェクトの概要ページの右上隅にあるコードを選択します。

  2. ドロップダウンリストで、次の項目の横にある copy-to-clipboard を選択して、リポジトリのURLをコピーします:

    • Clone with HTTPS（HTTPSでクローン）: GitLabアカウントでユーザー名とパスワードによる基本的な認証を使用している場合。
    • SSHでクローン: SSHを使用してGitLabで認証する場合。

  3. 次に、ローカルマシンでCLI（ターミナル、PowerShellなど）に切り替え、リポジトリをクローンするディレクトリに移動します。たとえば、/users/my-username/my-projects/です。

  4. git cloneを実行し、前にコピーしたURLを貼り付けます。次に例を示します:

    git clone https://gitlab.com/my-username/my-awesome-project.git

    これにより、リポジトリはmy-awesome-project/という新しいディレクトリにクローンされます。

リポジトリがコンピュータに保存されたので、Git CLIコマンドを使用する準備ができました。

ブランチをフェッチしてチェックアウトする

次に、更新するコミットを含んでいるブランチをチェックアウトする必要があります。

  1. CLIで前の手順と同じ場所に留まっているなら、cdでプロジェクトディレクトリに変更します:

    cd my-awesome-project

  2. オプション。リポジトリをクローンしたばかりであれば、ブランチもすでにコンピュータ上にあるはずです。ただし、以前にリポジトリをクローンしていて、この手順に直接進んだ場合は、次のコマンドでブランチをフェッチする必要がある場合があります:

    git fetch origin my-branch-name

  3. ブランチがローカルシステムにあることは確かであるため、そのブランチに切り替えます:

    git checkout my-branch-name

  4. git logで正しいブランチであることを確認し、最近のコミットがGitLabのブランチ内のコミットと一致することを確認します。ログを終了するには、qを使用します。

コミットメッセージを更新する

コミットメッセージを更新する準備ができました:

  1. GitLabで、コミット履歴をどこまで遡る必要があるかを確認します:

    • ブランチに対してマージリクエストがすでにオープンされている場合は、コミットタブを確認して、コミットの総数を使用できます。
    • ブランチからのみ作業している場合:
      1. コード > コミットに移動します。
      2. 左上にあるドロップダウンリストを選択し、ブランチを見つけます。
      3. 更新する最も古いコミットを見つけ、どれくらい前のコミットかを確認します。たとえば、2番目と4番目のコミットを更新する場合、カウントは4になります。

  2. コマンドラインインターフェース（CLI）から、インタラクティブなリベースを開始します。これは、コミットを更新するGitプロセスです。前の手順で確認したコミットのカウントをHEAD~の最後に追加します。次に例を示します:

    git rebase -i HEAD~4

    この例では、Gitはブランチ内の最近の4つのコミットを選択して更新します。

  3. Gitはテキストエディタを起動し、選択したコミットをリストします。たとえば、次のように表示されます:

    pick a0cea50 Fix broken link
pick bb84712 Update milestone-plan.md
pick ce11fad Add list of maintainers
pick d211d03 update template.md

# Rebase 1f5ec88..d211d03 onto 1f5ec88 (4 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 [-C | -c] <commit> = like "squash" but keep only the previous
#                    commit's log message, unless -C is used, in which case
# [and so on...]

  4. pickコマンドは、変更せずにコミットを使用するようにGitに指示します。更新するコミットに対するコマンドをpickからrewordに変更する必要があります。iと入力してINSERTモードに入り、テキストの編集を開始します。

    たとえば、上記の例で2番目と4番目のコミットのテキストを更新するには、次のように編集します:

    pick a0cea50 Fix broken link
reword bb84712 Update milestone-plan.md
pick ce11fad Add list of maintainers
reword d211d03 update template.md

  5. 編集したテキストを保存します。Escapeキーを押してINSERTモードを終了してから、:wqと入力し、Enterキーを押して保存し、終了します。

  6. Gitはコミットを1つずつ処理し、選択されたコマンドを適用します。pickを使用したコミットは、変更されずにブランチに再度追加されます。Gitはrewordを使用したコミットに到達すると、停止して、テキストエディタを再度開きます。ここで、コミットメッセージのテキストを更新します。

    • 1行のコミットメッセージのみが必要な場合は、必要に応じてテキストを更新します。次に例を示します:

      Update the monthly milestone plan

    • コミットメッセージにタイトルと本文が必要な場合は、空白行で区切ります。次に例を示します:

      Update the monthly milestone plan

Make the milestone plan clearer by listing the responsibilities
of each maintainer.

    保存して終了すると、Gitはコミットメッセージを更新し、次のコミットを順番に処理します。完了すると、Successfully rebased and update refs/heads/my-branch-nameというメッセージが表示されます。

  7. オプション。コミットメッセージが更新されたことを確認するには、git logを実行し、下にスクロールしてコミットメッセージを確認します。

変更をGitLabにプッシュする

残りの作業は、これらの変更をGitLabにプッシュすることです:

  1. CLIから、変更をGitLabにプッシュします。コミットが更新されたため、-f「強制プッシュ」オプションを使用する必要があります。強制プッシュはGitLabの古いコミットを上書きします。

    git push -f origin

    GitLabでコミットメッセージを上書きする前に、ターミナルからユーザー名とパスワードの入力を求められる場合があります。

  2. GitLabのプロジェクトで、コミットが更新されたことを確認します:

    • ブランチに対してマージリクエストがすでにオープンされている場合は、コミットタブを確認します。
    • ブランチからのみ作業している場合:
      1. コード > コミットに移動します。
      2. 左上にあるドロップダウンリストを選択し、ブランチを見つけます。
      3. リストの関連コミットが更新されたことを確認します。

おめでとうございます。コミットメッセージを正常に更新して、GitLabにプッシュできました。