[DOCS] Add a skill for the spec sync and regeneration pipeline - #37
Merged
Merged
Conversation
Nothing notifies this repo when the service's spec moves, and the upgrade that follows is ordered: copy the spec, move SPEC_SOURCE_REV with it, regenerate, review the generated surface with `git add -N` so new files count, then expose anything new through the facade. That sequence lived only in the heads of the people who built it. Records it as a repo-local skill, pointing at the existing scripts and gates rather than restating them. Calls out the two things about api-surface that are not guessable: it names modules rather than the package because the generated subpackage is public to griffe, so adding or renaming a public module means editing that list; and it cannot see the wire, which compat_test.py owns. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CSm32dsxD56PkKENgav3Mn
Contributor
|
| Filename | Overview |
|---|---|
| .claude/skills/spec-upgrade/SKILL.md | Documents the complete spec synchronization, SDK regeneration, validation, compatibility, versioning, release, and downstream-update workflow without introducing an actionable issue. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Copy upstream specification byte-for-byte] --> B[Update SPEC_SOURCE_REV]
B --> C[Run tools/gen_sdk.sh]
C --> D[Mark generated files intent-to-add]
D --> E[Review generated API changes]
E --> F[Expose new surface through client_v2.py]
F --> G[Run tox]
G --> H{Caller-facing compatibility}
H -->|Breaking| I[Select major release]
H -->|New behavior| J[Select minor release]
H -->|Compatible fix| K[Select patch release]
Reviews (2): Last reviewed commit: "docs: say what tox covers that pytest te..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
chandrasekharan-zipstack
changed the title
…he major bump Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CSm32dsxD56PkKENgav3Mn
Contributor
|
johnyrahul
approved these changes
Sep 8, 2026
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.
What
Adds
.claude/skills/spec-upgrade/SKILL.md— the ordered sequence for picking up a new LLMWhisperer spec, for a future maintainer or agent with no prior context.Nothing notifies this repo when
specs/llmwhisperer.jsonmoves upstream, and the upgrade that follows is ordered:SPEC_SOURCE_REVintools/gen_sdk.shin the same commit — without it, a stale copy and a current one both report clean./tools/gen_sdk.shgit add -Nfirst, so a newly generated file countsclient_v2.py, never the generated treetox, leaving thetests/baseline/parity reference where it isWhy
The pipeline is real and undocumented in-repo. It also writes down the two things about the
api-surfacegate that are not guessable from the workflow alone: it names modules rather than the package because the generated subpackage is public to griffe — so adding, deleting or renaming a public module means editing that list in the same PR — and it cannot see what goes out on the wire, whichtests/unit/compat_test.pyowns.No version numbers, dates or codenames, so it should not go stale.
Notes
Docs only — no code, no CI changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01CSm32dsxD56PkKENgav3Mn