Git Notes

Git Notes fügen Textnotizen zu Commits, Tags und anderen Objekten hinzu. Solche Notizen können alle Arten von Metadaten enthalten, z.B. Kommentare zur Codeüberprüfung, Links zu Fehlerberichten usw:

  1. Hinzufügen einer Git-Notiz:

    $ git notes add -m 'Example note'

  2. Anzeigen einer Git-Notiz:

    $ git log
commit 859de540cda23f510f4ecbe0f38d07666e933f08 (HEAD -> main)
Author: Veit Schiele <veit@cusy.io>
Date:   Sun Mar 24 11:17:56 2024 +0100

    A commit message

Notes:
    Example note

  3. Ändern einer Git-Notiz:

    $ git notes edit

Git Notes werden jedoch nicht standardmäßig mit git push oder git pull an das entfernte Repository übermittelt; sie müssen mit git push origin 'refs/notes/*' und git fetch origin 'refs/notes/*:refs/notes/*' synchronisiert werden.

Warnung

Verwendet nicht git pull anstelle von git fetch: ihr könnt refs/notes/commits nicht mit eurem aktuellen Zweig zusammenführen.

Bemerkung

Git Notes werden nicht in die Git-Commit-Historie aufgenommen, sodass sie nicht sind nicht für Regulatorisches verwendet werden können, bei dem die Herkunft, Nichtabstreitbarkeit oder Manipulationssicherheit nachgewiesen werden muss. Sie könnxen jedoch z.B. für Build-Tags und ähnliches nützlich sein.

Siehe auch