getNote()

Read a note attached to a specific commit.

Git notes allow you to attach metadata to commits without modifying the commit itself. Notes are stored in refs/notes/commits and are useful for storing build status, review comments, or other annotations.

TypeScript

const note = await repo.getNote({ sha: "abc123def456..." });
console.log(`Note for ${note.sha}: ${note.note}`);
console.log(`Notes ref SHA: ${note.refSha}`);

Options

Parameter	Type	Description
sha	Required	Commit SHA to read the note from
ttl	Optional	Token TTL in seconds

Response

Field	Type	Description
sha	String	The commit SHA
note	String	The note content
refSha (TypeScript) ref_sha (Python)	String	Current SHA of refs/notes/commits