docs: refresh AGENTS.md for current toolchain and smoke gate - #166
Open
jhamon wants to merge 1 commit into
Open
Conversation
- Go version was listed as 1.21+, but go.mod requires 1.25.0 and CI pins 1.25.x. - Document the key-free mocked smoke gate added in #150; it was absent from the test commands, so agents had no way to run the one suite that needs no credentials. - Note pinecone/retry.go in the public API map. RetryPolicy and DefaultRetryPolicy() are exported and documented in the README, but the file was missing from the architecture section. - Refresh the audit date.
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.
Housekeeping pass on
AGENTS.mdafter setting the repo up on a new machine. Four stale/missing items, all verified against the tree rather than assumed.Changes
1.21+;go.modrequiresgo 1.25.0and both CI jobs pin1.25.x.smoke/suite added in test(smoke): mocked critical-path gate that runs keyless on every PR #150 was absent from the Build & Test section. It is the only suite runnable without credentials, so leaving it undocumented meant an agent (or a new contributor) with no.envhad no way to find it.pinecone/retry.go.RetryPolicy/DefaultRetryPolicy()are exported and documented in the README, but the file was missing from the public API map.Docs only — no code touched.
Verification
On this branch, with no
.envand noPINECONE_API_KEYin the environment:just build— builds clean,go vet ./...cleanjust test-unit— 111 passed, 0 failedgo test -tags smoke -run '^TestMockedCriticalPath$' -v -count=1 ./smoke/...— passes, exactly as documented in the new blockIntegration tests (
just test) were not run — they needPINECONE_API_KEY/PINECONE_CLIENT_ID/PINECONE_CLIENT_SECRET, which I did not have set up.Follow-up, not included here
CONTRIBUTING.mdcarries the same stale Go floor ("recommended 1.21+"). Left out to keep this scoped toAGENTS.md; happy to fold it in.Note
Low Risk
Documentation-only changes with no runtime or API behavior impact.
Overview
Docs-only update to
AGENTS.mdso agent/contributor guidance matches the current repo.The Go toolchain floor is bumped from 1.21+ to 1.25+, aligned with
go.modand CI.The public API map now lists
pinecone/retry.go(RetryPolicy,DefaultRetryPolicy(), REST/gRPC retry wiring).Build & Test documents the credential-free mocked smoke gate:
go test -tags smoke -run '^TestMockedCriticalPath$' ... ./smoke/..., plus a short note thatsmoke/is build-tagged, runs against a mocked backend, and is used in CI on the connect → upsert → query path (with a pointer tosmoke/README.md).The last audited footer is updated to August 19, 2026.
Reviewed by Cursor Bugbot for commit 7a6f0e8. Bugbot is set up for automated code reviews on this repo. Configure here.