Skip to main content
Git notes allow you to attach metadata to commits without modifying the commit itself. Notes are read from refs/notes/commits by default. Pass ref to read from another notes ref. See Git Notes for notes ref rules and write behavior.

Options

string
required
Commit SHA to read the note from
string
Notes ref to read from. Accepts short names like reviews, notes/reviews, or full refs like refs/notes/reviews; all are normalized to a full refs/notes/* ref. Defaults to refs/notes/commits. Go: Ref.
string
Token TTL. Token TTL in seconds.

Response

string
The commit SHA
string
The note content
string
Current SHA of the notes ref that was read