feat: add configurable notes refs and a list-notes-refs API#38
Merged
Conversation
jacobbednarz
approved these changes
Jul 7, 2026
A caller can now attach, read, append, and delete notes on any refs/notes/* ref instead of only refs/notes/commits, and can list a repository's notes refs to discover custom namespaces (for example review notes kept separate from other kinds). The notes methods previously hardcoded refs/notes/commits and there was no way to enumerate notes refs. Add an optional notes ref to getNote/createNote/appendNote/deleteNote (get_note/... in Python, GetNote/... in Go), sent as the `ref` query param on reads and the `ref` body field on writes. A bare name like `reviews` is placed under refs/notes/ server-side (matching `git notes --ref`) and it defaults to refs/notes/commits, so existing calls are unchanged; targeting a custom ref requires the feature to be enabled server-side. Add listNotesRefs/list_notes_refs/ListNotesRefs, which pages the notes refs under a prefix via GET /repos/notes/refs and returns each ref and tip SHA with a cursor, next_cursor, and has_more. Document both in the code-storage skill and the per-SDK READMEs.
necolas
force-pushed
the
git-notes-refs-sdk
branch
from
3f2c18c to
a8cb8af
Compare
Ship the configurable notes refs and list-notes-refs work with a synchronized SDK release version: - TypeScript: 1.14.0 -> 1.15.0 - Python: 1.13.0 -> 1.15.0 - Go: 0.12.0 -> 1.15.0
necolas
force-pushed
the
git-notes-refs-sdk
branch
from
a8cb8af to
8d6696c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(NOTE: This feature is behind a flag. Wait for it to be enabled before updating the public docs.)
A caller can now attach, read, append, and delete notes on any refs/notes/* ref instead of only refs/notes/commits, and can list a repository's notes refs to discover custom namespaces (for example review notes kept separate from other kinds).
The notes methods previously hardcoded refs/notes/commits and there was no way to enumerate notes refs. Add an optional notes ref to getNote/createNote/appendNote/deleteNote (get_note/... in Python, GetNote/... in Go), sent as the
refquery param on reads and therefbody field on writes. A bare name likereviewsis placed under refs/notes/ server-side (matchinggit notes --ref) and it defaults to refs/notes/commits, so existing calls are unchanged; targeting a custom ref requires the feature to be enabled server-side.Add listNotesRefs/list_notes_refs/ListNotesRefs, which pages the notes refs under a prefix via GET /repos/notes/refs and returns each ref and tip SHA with a cursor, next_cursor, and has_more.
Document both in the code-storage skill and the per-SDK READMEs.