docs: pin the README's examples to v2 - #7
Merged
Merged
Conversation
Every `uses:` snippet still said `@v1`, so anyone copying one landed on the previous major. v2.0.0 was a breaking change — GitHub Models was retired on 2026-07-30 and Layer 3 needs a provider API key — and the surrounding prose already explains that, which made the snippets the only thing still pointing at v1. Seven occurrences, all of them copy-paste usage examples rather than before-and-after migration snippets, so there is nothing here that should stay on v1. A bare `@v2` with no `ai-api-key` does not fail: config warns that Layer 3 is disabled and falls back to Layers 1 and 2. So the quickstart stays a two-line snippet and keeps working as written.
🧪 Test-Guard Report✅ PASS — All changed source files have adequate test coverage. Coverage Analysis: ⏭️ SKIPNo source files to analyze — all changed files are tests or excluded. Test File Matching: ✅ PASSNo source files to check Per-File Evaluation: ✅ PASSNo source files to evaluate. Result: ✅ PASS |
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.
Every
uses:snippet in the README saidostico/test-guard@v1, so anyone copying one landed on the previous major — including the quickstart. Seven occurrences, now@v2.They were all copy-paste usage examples. None were before-and-after migration snippets, so nothing here should stay on v1.
The surrounding prose is already v2-aware: it explains that GitHub Models was retired on 2026-07-30 and that Layer 3 now needs a provider API key. The snippets were the only thing left pointing at the old major.
The quickstart still works as written. A bare
@v2with noai-api-keydoes not fail —config.pywarns that Layer 3 is disabled and falls back to Layers 1 and 2 — so the two-line snippet stays a two-line snippet rather than growing a key and a secret.Documentation only; no source or test changes.