deleteNote()

Remove a note from a 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 result = await repo.deleteNote({
  sha: "abc123def456...",
  author: { name: "Cleanup Bot", email: "[e-mail]" },
  expectedRefSha: currentNotesRefSha, // optional optimistic lock
});

console.log(`Note deleted, new ref: ${result.newRefSha}`);

Options

Parameter	Type	Description
sha	Required	Commit SHA to remove the note from
author	Optional	Author signature (name and email)
expectedRefSha (TypeScript) expected_ref_sha (Python)	Optional	Expected notes ref SHA for optimistic concurrency control
ttl	Optional	Token TTL in seconds

Response

Field	Type	Description
sha	String	The commit SHA the note was attached to
targetRef (TypeScript) target_ref (Python)	String	The notes reference (refs/notes/commits)
baseCommit (TypeScript) base_commit (Python)	Optional	Previous notes ref commit SHA
newRefSha (TypeScript) new_ref_sha (Python)	String	New notes ref SHA after the operation
result	Object	Operation result with success, status, and optional message

Throws RefUpdateError when the notes ref has been modified concurrently (if expectedRefSha was provided) or if the operation fails.