feat(p0-07): re-vendor canonical snippet + SHA-pin drift CI#5
Merged
Conversation
- src/fixyourdocs/snippet.py: re-vendor the canonical block from fixyourdocs/agents-md-snippet#1. New body is v0-schema-conformant (top-level `protocol_version` / `doc_url` / `agent` / `report` with nested `kind` + `summary`); the previous flat-keys body would have been rejected by any v0 Hub. - .github/workflows/snippet-drift.yml + scripts/check_snippet_drift.py: daily + per-PR check that fetches README.md from agents-md-snippet main, extracts the markdown block, and SHA-256-compares with the vendored copy. Tolerates the cross-repo content-lock window — if main is out of sync but an open upstream PR matches the vendored copy, the check exits 0 with a warning. Closes the verification gap left by P0-04 step 6. - AGENTS.md: dogfood the same block in this repo. Ruff, mypy, pytest all green locally (57/57 tests). Signed-off-by: mstopa <m.stopa94@gmail.com>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Python half of the snippet finalization rolled out in agents-md-snippet#1 and sdk-typescript#6.
src/fixyourdocs/snippet.py— re-vendored to the new v0-schema-conformant body. Previous flat-keys example would have been rejected by any v0 Hub..github/workflows/snippet-drift.yml+.github/scripts/check_snippet_drift.py— fetchesREADME.mdfromagents-md-snippet'smain, extracts the fenced```markdownblock, SHA-256-compares to the vendored body insrc/fixyourdocs/snippet.py. Runs on every push tomain, every PR, and daily on cron. Tolerates the cross-repo content-lock window: ifmaindoes not match but an open upstream PR carries a matching block, the check exits 0 with a warning until the upstream PR merges.AGENTS.md— dogfood the same block in this SDK repo.Test plan
ruff check .,mypy src/fixyourdocs,pytest -q— all green locally (57/57 tests).python3 .github/scripts/check_snippet_drift.pyexits 0 locally — currently with the cross-repo content-lock warning until agents-md-snippet#1 merges.CIworkflow (3.9 → 3.13 matrix) green.snippet-driftgreen (warning in logs is expected until upstream merges).src/fixyourdocs/snippet.pySNIPPET body matches the block in agents-md-snippet PR #1 README and the sister TypeScript SDK PR.Follow-ups not addressed here
P0-08/P0-09). When both are done, tag both SDKs in the same hour.