Synopsis
git describe --tags --dirty --always [--match 'v[0-9]*']Description
This page covers git describe from a versioning angle: how to design a tag scheme that drives reproducible build version strings. The output of git describe is widely used by build systems (Make, CMake, Cargo, npm scripts) to generate a version string that includes a base tag plus distance and SHA.
The recommended pattern: use annotated semver tags like v1.2.3; build scripts call git describe --tags --dirty --always --match 'v[0-9]*'; the resulting string is embedded into binaries via a generated header or constant. This produces deterministic versions that reflect both the latest release and any unreleased work since.
Dans l'usage quotidien, git describe (versioning) 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 (versioning) --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 (versioning) 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 (versioning) aide à éviter les trois.
Options courantes
| Option | Description |
|---|---|
--tags | Utiliser les tags lightweight ainsi que les annotés. |
--dirty[=<mark>] | Ajouter un marqueur si l'arbre est sale. |
--always | Retomber sur un SHA abrégé quand aucun tag n'est atteignable. |
--long | Forcer le format long même sur un tag. |
--match <pattern> | Restreindre aux tags correspondant à un motif (par ex. exclure nightly-*). |
--exclude <pattern> | Exclure les tags correspondants. |
--abbrev=<n> | Longueur de SHA abrégée. |
Exemples
# Generate a version string for a build
VERSION=$(git describe --tags --dirty --always --match 'v[0-9]*')
echo "${VERSION#v}" > VERSION
# In a Makefile:
VERSION := $(shell git describe --tags --dirty --always)
CFLAGS += -DVERSION="\"$(VERSION)\""
# In package.json prepublish script:
node -e "p=require('./package.json'); p.version=process.env.VERSION; require('fs').writeFileSync('package.json', JSON.stringify(p,null,2))"Erreurs fréquentes
Using lightweight tags breaks git describe without --tags. Including release candidate or nightly tags in your match pattern produces noisy versions for stable builds. Shallow CI clones may have no tags at all — fetch them explicitly: git fetch --tags --unshallow.
Commandes liées
git tag, git rev-parse, git for-each-ref, git log