git describe-Befehl
git describeDer Befehl dient dazu, eine lesbare Zeichenkette zu erzeugen, die den aktuellen Commit anhand des Git-Tag-Systems beschreibt.
git describeDer Befehl wird typischerweise verwendet, um Versionsnummern zu generieren, die helfen, bestimmte Commits zu identifizieren, und kann beim Bauen, Veröffentlichen oder Nachverfolgen bestimmter Versionen verwendet werden.
Grundlegende Syntax
git describe [<options>] [<commit>]
<commit>: Gibt den zu beschreibenden Commit an. Standardmäßig wird der aktuelle Commit verwendet.<options>: Optionen zum Anpassen des Ausgabeformats oder Verhaltens.
Häufige Optionen und Verwendung:
| Optionen | Beschreibung | Verwendungsbeispiel |
|---|---|---|
--tags | Alle Tags (einschließlich Lightweight-Tags) verwenden, um die Beschreibung zu generieren. Standardmäßiggit describenur annotierte Tags berücksichtigen. | git describe --tags |
--abbrev=<n> | Legen Sie die Mindestlänge des anzuzeigenden Commit-Hashes auf<n>Zeichen. | git describe --abbrev=8 |
--long | Erzwingt eine ausführliche Beschreibung, einschließlich des Commit-Hashes und der Anzahl der Commits seit dem Tag. | git describe --long |
--exact-match | Gib den Tag-Namen nur zurück, wenn der aktuelle Commit genau mit dem Tag übereinstimmt. | git describe --exact-match |
--dirty | Wenn das Arbeitsverzeichnis Änderungen (nicht committete Änderungen) aufweist, füge zur Beschreibung ein-dirtySuffix hinzu. | git describe --dirty |
--match=<pattern> | Verwende für die Beschreibung nur Tags, die dem angegebenen Muster entsprechen. | git describe --match "v1.*" |
--candidates=<n> | Begrenze die Anzahl der für die Beschreibung berücksichtigten Tags; Standard ist 10. | git describe --candidates=5 |
--always | Commit-Hash anzeigen, auch wenn kein Tag gefunden wird. | git describe --always |
Häufige Verwendung
1. Aktuellen Commit beschreiben
Erzeuge eine Beschreibungszeichenfolge basierend auf dem neuesten Tag:
git describe
Beispielausgabe:
v1.2-15-g2414721
Die Ausgabe hier zeigt an, dass der aktuelle Commit 15 Commits vom nächstgelegenen Tag v1.2 entfernt ist und der aktuelle Commit-Hash 2414721 lautet.
2. Mit allen Tags beschreiben
Alle Tags (leichtgewichtige und annotierte Tags) einbeziehen, um die Beschreibung zu generieren:
git describe --tags
3. Beschreibung im Langformat anzeigen
Lange Beschreibung anzeigen, einschließlich Hash und der Anzahl der Commits vom Tag:
git describe --long
4. Den Tag-Namen nur zurückgeben, wenn der Commit exakt mit dem Tag übereinstimmt
Wenn der aktuelle Commit exakt mit einem Tag übereinstimmt, wird nur der Tag-Name zurückgegeben:
git describe --exact-match
5. -dirty-Suffix hinzufügen
Wenn das Arbeitsverzeichnis nicht committete Änderungen enthält, fügen Sie der Beschreibung das Suffix -dirty hinzu:
git describe --dirty
6. Nur Tags verwenden, die dem Muster entsprechen
Verwenden Sie Tags, die dem angegebenen Muster entsprechen, für die Beschreibung:
git describe --match "v1.*"
7. Commit-Hash auch dann anzeigen, wenn kein Tag gefunden wird
Den aktuellen Commit-Hash auch dann anzeigen, wenn kein Tag vorhanden ist:
git describe --always
Weitere Erweiterungen