git describe コマンド

Git 基本操作Git 基本操作


git describeこのコマンドは、Git のタグシステムに基づいて現在のコミットを説明する、読みやすい文字列を生成するために使用されます。

git describeこのコマンドは通常、バージョン番号を生成するために使用され、特定のコミットを識別するのに役立ち、ビルド、リリース、または特定バージョンの追跡に使用できます。

基本構文

git describe [<options>] [<commit>]
  • <commit>:説明するコミットを指定します。デフォルトは現在のコミットです。
  • <options>:出力形式や動作をカスタマイズするためのオプションです。

一般的なオプションと使用方法:

オプション説明使用例
--tagsすべてのタグ(軽量タグを含む)を使用して説明を生成します。デフォルトでは、git describe注釈タグのみが考慮されます。git describe --tags
--abbrev=<n>表示するコミットハッシュの最小長を<n>文字に設定します。git describe --abbrev=8
--longコミットのハッシュとタグからのコミット数を含む、長い形式の説明を強制的に表示します。git describe --long
--exact-match現在のコミットがタグと完全に一致する場合のみ、タグ名を返します。git describe --exact-match
--dirty作業ディレクトリに変更(未コミットの変更)がある場合、説明に-dirty接尾辞を追加します。git describe --dirty
--match=<pattern>指定されたパターンに一致するタグのみを使用して説明します。git describe --match "v1.*"
--candidates=<n>説明で考慮するタグの数を制限します。デフォルトは 10 個です。git describe --candidates=5
--alwaysタグが見つからなくても、コミットのハッシュを表示します。git describe --always

一般的な使い方

1、現在のコミットを説明する

最近のタグに基づく説明文字列を生成します:

git describe

出力例:

v1.2-15-g2414721

ここの出力は、現在のコミットが最新のタグ v1.2 から 15 コミット離れており、現在のコミットのハッシュが 2414721 であることを示しています。

2、すべてのタグを使用して説明する

すべてのタグ(軽量タグと注釈タグ)を含めて説明を生成します:

git describe --tags

3、長い形式の説明を表示する

ハッシュとタグからのコミット数を含む、長い形式の説明を表示します:

git describe --long

4、コミットがタグと完全に一致する場合のみタグ名を返す

現在のコミットが何らかのタグと完全に一致する場合、タグ名のみを返します:

git describe --exact-match

5、-dirty 接尾辞を追加する

作業ディレクトリに未コミットの変更がある場合、説明に -dirty 接尾辞を追加します:

git describe --dirty

6、パターンに一致するタグのみを使用する

指定されたパターンに一致するタグを使用して説明します:

git describe --match "v1.*"

7、タグが見つからなくてもコミットハッシュを表示する

タグがない場合でも、現在のコミットのハッシュを表示します:

git describe --always

Git 基本操作Git 基本操作

その他の拡張