Skip to main content
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. 
const result = await repo.createNote({
  sha: "abc123def456...",
  note: "Build passed ✓ - deployed to staging",
  author: { name: "CI Bot", email: "ci@example.com" },
  expectedRefSha: currentNotesRefSha, // optional optimistic lock
});

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

​
Options

​
sha
string
required
Commit SHA to attach the note to
​
note
string
required
Note content
​
author
string
Author signature (name and email)
​
expectedRefSha
string
Expected notes ref SHA for optimistic concurrency control
​
ttl
string
Token TTL. Token TTL in seconds.
​
refPolicies
object[]
Ordered per-ref policy rules ({ pattern, ops? }) embedded in the per-call JWT. Evaluated against refs/notes/commits. Python: ref_policies. Go: RefPolicies with type storage.RefPolicyList. See the Branch Protection guide.

​
Response

​
sha
string
The commit SHA the note is attached to
​
targetRef
string
The notes reference (refs/notes/commits)
​
baseCommit
string
Previous notes ref commit SHA
​
newRefSha
string
New notes ref SHA after the operation
​
result
object
Operation result with success, status, and optional message