kledgeb Ubuntuの使い方や日本語化、アプリの使い方を紹介しています。

コミットメッセージのテンプレートを指定して、コミットを行う

  「コミットメッセージ」のテンプレートを指定して、コミットを行います。

  コミットメッセージのテンプレートとは

    いわゆる雛形のことです。

    ユーザーは「コミットメッセージ」に任意の文章を記述できます。
    しかしプロジェクトによっては、記述方法にルールを設けています。

    このルールに従ったフォーマットを提供したい場合、「コミットメッセージ」のテンプレートを用意すると良いでしょう。

    テンプレートを指定すると、「コミットメッセージ」入力時にテンプレートに記述された文章が「コミットメッセージ」に反映されます。

  オプションでコミットメッセージを指定した場合

    オプションで「コミットメッセージ」を指定した場合、指定した「コミットメッセージ」が優先されテンプレートは使用されません。

  コミットメッセージを編集せずコミットしないこと

    テンプレートの文章のまま「コミットメッセージ」を変更せずコミットしないでください。
    「コミットメッセージ」を編集せずコミットを続行した場合、コミットが中止されます。

コミットメッセージのテンプレート

  予め、「コミットメッセージ」のテンプレートを用意しておきます。

  ここでは例として、以下の「コミットメッセージ」をテンプレートを記述したテキストファイルを用意しました。


  ファイルのパスは、「~/git/CommitMessageTemplate.txt」です。
  テキストファイルの内容は、以下のようになっています。


    「コミットタイトル」用に、最初の2行は空白行にしておくと良いでしょう。

コマンドの実行例

  コマンドの実行例です。

  1.ブランチの確認

    現在のブランチ構成を確認すると、以下のようになっています。
    現在のブランチは、「master」ブランチであることが分かります。
    同様に、「HEAD」は「master」ブランチを指していることが分かります。


  2.ブランチの構成

    現在のブランチの構成を図にすると、以下のようになっています。


  3.ワーキングディレクトリーの状態

    「ワーキングディレクトリー」の状態を確認すると、以下のようになっています。


  4.コマンドの実行 

    コマンドのオプションは、以下のオプションを指定します。

ショートオプション ロングオプション オプションの値
-t --template= ファイルのパス

    「端末」から、以下のコマンドを実行します。
    コマンドの詳細は、「スナップショットを生成するコマンドの説明」を参考にしてください。

    ポイントは、赤字の箇所です。

git commit --template='../CommitMessageTemplate.txt'


  5.コミットメッセージの入力

    テキストエディターが起動し、「コミットメッセージ」を入力する画面が表示されます。
    オプションで指定した「コミットメッセージ」のテンプレートがすでに入力されている状態です。


    ここでは例として、以下のように入力しました。


    「コミットメッセージ」を入力したら、ファイルを上書き保存してテキストエディターを終了します。

  6.コマンドの実行結果

    以下のように、コミットが行われます。


  7.ブランチの確認

    現在のブランチ構成を確認すると、以下のようになっています。
    「master」ブランチが指す「コミットオブジェクト」の識別子が、「1.」と異なっています。


  8.ブランチの構成

    現在のブランチの構成を図にすると、以下のようになっています。


  9.ワーキングディレクトリーの状態

    「ワーキングディレクトリー」の状態を確認すると、以下のようになっています。


  10.コミットログの確認

    「Commit6」のコミットログを確認すると、入力した 「コミットメッセージ」が反映されています。 



関連コンテンツ
同一カテゴリーの記事
コメント
オプション