Add temporary note on v1.13 compatility requirements#2150
Conversation
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds a temporary version-compatibility notice across the SDK READMEs, example READMEs, and integration docs warning users that the hosted ENSNode instances run v1.13 and that they must pin enssdk@1.13.1 / enskit@1.13.1 rather than the latest 1.14.0+ releases. Introduces a reusable HostedInstanceSdkVersionWarning.astro component and threads a for prop through IntegrateHostedEnsNodeTip.astro to control which SDKs are mentioned.
Changes:
- New
HostedInstanceSdkVersionWarning.astrocomponent, embedded in the hosted-instances, integrate, enssdk/enskit guide, and playground pages. - README notices added in
packages/enssdk,packages/enskit, and the four example READMEs. IntegrateHostedEnsNodeTip.astronow accepts aforprop and renders the new warning; existing usages updated to pass it.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/enssdk/README.md | Adds version-compatibility blockquote with pinned install command. |
| packages/enskit/README.md | Adds package summary, Installation section, and pinned-version notice. |
| examples/omnigraph-graphql-example/README.md | Adds hosted-instance version warning. |
| examples/enssdk-example/README.md | Adds hosted-instance version warning. |
| examples/enskit-react-example/README.md | Adds hosted-instance version warning (mentions both packages). |
| docs/…/enssdk/index.mdx | Switches tip to caution; adds explicit v1.13 pin guidance; passes for="enssdk". |
| docs/…/enssdk/example.mdx | Imports and renders the new warning component. |
| docs/…/enskit/index.mdx | Switches tip to caution; adds explicit v1.13 pin guidance; passes for="enskit". |
| docs/…/enskit/example.mdx | Imports and renders the new warning component. |
| docs/…/integrate/index.mdx | Renders the warning above the enskit and enssdk code samples. |
| docs/…/hosted-instances.mdx | Renders the warning with for="both". |
| docs/…/IntegrateHostedEnsNodeTip.astro | Adds for prop and embeds the new warning. |
| docs/…/HostedInstanceSdkVersionWarning.astro | New reusable warning component. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile SummaryThis PR adds a temporary compatibility notice across docs, package READMEs, and example READMEs warning users that the NameHash-hosted ENSNode instances run v1.13, while the latest published SDKs (
Confidence Score: 5/5Documentation-only change adding temporary compatibility warnings; no runtime logic is affected. All changes are documentation and Astro component additions. The new component renders HTML correctly (previous markdown-in-template issues were fixed). The only notable side-effect is that omnigraph-graphql-api.mdx will now display the version warning via the changed default on IntegrateHostedEnsNodeTip, but the warning content is appropriate for that page. No files require special attention beyond the implicit change to omnigraph-graphql-api.mdx via the updated IntegrateHostedEnsNodeTip default. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["HostedInstanceSdkVersionWarning.astro\n(for: 'enssdk' | 'enskit' | 'both')"] --> B{target}
B -->|enssdk| C["Show enssdk@1.13.1 warning\nnpm install enssdk@1.13.1"]
B -->|enskit| D["Show enskit+enssdk warning\nnpm install enskit@1.13.1 enssdk@1.13.1"]
B -->|both| E["Show both SDKs warning\n(enssdk first, enskit optional for React)"]
F["IntegrateHostedEnsNodeTip.astro\n(for: default='both')"] -->|passes for prop| A
G[hosted-instances.mdx] -->|for=both| A
H[integrate/index.mdx] -->|for=enskit| A
H -->|for=enssdk| A
I[enskit/index.mdx] -->|for=enskit| F
J[enssdk/index.mdx] -->|for=enssdk| F
K[enskit/example.mdx] -->|for=enskit| A
L[enssdk/example.mdx] -->|for=enssdk| A
M["omnigraph-graphql-api.mdx\n(no for prop → default 'both')"] --> F
Reviews (3): Last reviewed commit: "Fix markdown in astro" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
@greptile review |
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@tk-o Thanks for this! Looks good! 👍
lightwalker-eth
merged commit 6c59d33
into
docs/2115-add-scalability-story-to-ensnode-self-host-module
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
v1.13that is currently running in production.Why
v1.14.Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)