Synopsis
git describe [--tags] [--always] [--dirty] [<commit>]Description
The git describe command produces a human-readable name for a commit based on the most recent reachable tag. The output looks like v1.4.2-13-gabc1234, meaning "13 commits past tag v1.4.2, at SHA abc1234." If the commit is exactly at a tag, only the tag name is printed.
Build systems use git describe to embed version strings into binaries. With --dirty, the output includes a -dirty suffix when the working tree has uncommitted changes — perfect for marking development builds.
Dans l'usage quotidien, git describe s'intègre étroitement avec les alias de shell, les plugins d'éditeur et l'intégration continue. Les utilisateurs avancés ajoutent souvent des alias combinant les flags qu'ils passent toujours, ou enveloppent la commande dans des scripts qui appliquent les conventions d'équipe. Le formatage de la sortie peut être personnalisé via la configuration Git — pretty formats, schémas de couleurs et comportement du pager sont tous ajustables. Quand quelque chose tourne mal, la première étape de diagnostic est généralement de relancer la commande avec GIT_TRACE=1 dans l'environnement, ce qui révèle les appels de plomberie sous-jacents. Pour les situations inhabituelles, la sortie --help (git describe --help) ouvre la page de manuel complète avec les détails de chaque option, y compris celles rarement utilisées dans les workflows ordinaires mais essentielles pour le débogage ou le scripting à grande échelle.
Comprendre comment git describe interagit avec le reste du modèle de données de Git — la base d'objets, l'index, les refs et l'arborescence de travail — est rentable. Chaque commande opère sur un sous-ensemble de ces pièces, et savoir laquelle elle touche aide à prédire les résultats et récupérer après les erreurs. Lire la documentation officielle de Git en parallèle de la pratique sur un dépôt jetable est la façon la plus rapide d'intérioriser les subtilités. La plupart des problèmes de production avec Git proviennent de l'une de trois causes : comportement par défaut surprenant, opérations réseau partielles, ou réécriture d'historique déjà partagé. Un modèle mental fonctionnel des effets de bord de git describe aide à éviter les trois.
Options courantes
| Option | Description |
|---|---|
--tags | Utiliser les tags lightweight ainsi que les annotés. |
--always | Retomber sur un SHA abrégé si aucun tag n'est atteignable. |
--dirty[=<mark>] | Ajouter un marqueur si l'arborescence est sale. |
--long | Toujours afficher le format long, même sur un tag. |
--match <pattern> | Ne considérer que les tags correspondant à un glob. |
--abbrev=<n> | Use n chiffres hex pour le SHA. |
--contains | Afficher le tag le plus ancien contenant le commit. |
Exemples
git describe
# par ex. v2.1.0-3-g1a2b3c4
git describe --tags --dirty --always
# Chaîne de version robuste pour scripts de build
git describe --match 'v[0-9]*'
# Ne considérer que les tags style semver
git describe --contains abc123
# Trouver la première release qui inclut un commitErreurs fréquentes
If your repo has only lightweight (non-annotated) tags, plain git describe says "fatal: No names found." Use --tags. Shallow clones may have no reachable tags at all — fetch tags explicitly with git fetch --tags.
Commandes liées
git tag, git log, git rev-parse, git show