commande git describe

Opérations de base Git


git describeLa commande est utilisée pour générer une chaîne lisible qui décrit le commit actuel en se basant sur le système d'étiquettes de Git.

git describeLa commande est généralement utilisée pour générer des numéros de version, ce qui aide à identifier des commits spécifiques, et peut être utilisée lors de la construction, de la publication ou du suivi de versions spécifiques.

Syntaxe de base

git describe [<options>] [<commit>]
  • <commit>: Spécifie le commit à décrire. Par défaut, il s'agit du commit actuel.
  • <options>: Options pour personnaliser le format de sortie ou le comportement.

Options courantes et utilisation :

OptionsDescriptionExemple d'utilisation
--tagsUtiliser toutes les étiquettes (y compris les étiquettes légères) pour générer la description. Par défaut,git describeNe considérer que les étiquettes annotées.git describe --tags
--abbrev=<n>Définir la longueur minimale d'affichage du hash de commit à<n>caractères.git describe --abbrev=8
--longForcer une description au format long, incluant le hash du commit et le nombre de commits depuis l'étiquette.git describe --long
--exact-matchRenvoyer le nom du tag uniquement lorsque le commit actuel correspond exactement au tag.git describe --exact-match
--dirtySi le répertoire de travail contient des modifications (modifications non validées), ajouter à la description-dirtysuffixe.git describe --dirty
--match=<pattern>Utiliser uniquement les tags correspondant au motif spécifié pour la description.git describe --match "v1.*"
--candidates=<n>Limiter le nombre de tags pris en compte pour la description, la valeur par défaut est 10.git describe --candidates=5
--alwaysAfficher le hash du commit même si aucun tag n'est trouvé.git describe --always

Utilisation courante

1. Décrire le commit actuel

Générer une chaîne de description basée sur le tag le plus récent :

git describe

Exemple de sortie :

v1.2-15-g2414721

La sortie ici indique que le commit actuel est à 15 commits du tag le plus proche v1.2, et que le hash du commit actuel est 2414721.

2. Décrire en utilisant tous les tags

Inclure tous les tags (tags légers et tags annotés) pour générer la description :

git describe --tags

3. Afficher la description au format long

Afficher la description longue, y compris le hash et le nombre de commits depuis le tag :

git describe --long

4. Renvoyer uniquement le nom du tag lorsque le commit correspond exactement au tag

Si le commit actuel correspond exactement à un tag, seul le nom du tag est renvoyé :

git describe --exact-match

5. Ajouter le suffixe -dirty

Si le répertoire de travail contient des modifications non validées, ajouter le suffixe -dirty à la description :

git describe --dirty

6. N'utiliser que les tags correspondant au motif

Utiliser les tags correspondant au motif spécifié pour la description :

git describe --match "v1.*"

7. Afficher le hash du commit même si aucun tag n'est trouvé

Afficher le hash du commit actuel même lorsqu'il n'y a pas de tag :

git describe --always

Opérations de base Git

autres extensions