feat(sdk): expose notes on commit history - #56
Open
necolas wants to merge 2 commits into
Open
Conversation
Pass notes refs to list-commits in TypeScript, Python, or Go, and read the returned notes from each commit. The clients preserve empty maps and null values so callers can distinguish no note from an over-limit note. Update package docs and the Code Storage skill with the request and response contract.
Restore the existing layout of two Python tests that are outside the inline notes change. This keeps the feature diff focused on its own behavior.
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
1 participant
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.
Why
listCommitsreturns commit metadata without Git notes. A history view that shows notes must make one additional request for each commit and notes ref.The HTTP support is in monorepo PR #2421.
Scope
Add optional notes-ref arguments to
listCommitsin the TypeScript, Python, and Go SDKs. Each SDK sends onenotes_refquery key for each value.Add an optional notes map to each commit result. Preserve an omitted map, an empty map, and a
nullvalue as distinct states.Update the package documentation and the Code Storage skill with the request and response contract.
Tradeoffs
The server limits a request to four distinct notes refs. A
nullvalue means that the note exceeded an inline response limit, so the caller must read it withgetNote.Blast Radius
The new arguments and result fields are optional. Existing
listCommitscalls keep their current request and response behavior.Do not release or advertise this SDK feature until the complete service rollout of monorepo PR #2421 is complete.
Verification
go test ./...andgo vet ./...passed.