Skip to content

docs(repo): add hotload boundary ABI inventory and review gate#8614

Draft
jacekradko wants to merge 2 commits into
mainfrom
jacek/hotload-boundary-tracking
Draft

docs(repo): add hotload boundary ABI inventory and review gate#8614
jacekradko wants to merge 2 commits into
mainfrom
jacek/hotload-boundary-tracking

Conversation

@jacekradko
Copy link
Copy Markdown
Member

@jacekradko jacekradko commented May 21, 2026

Documents the hotload-boundary ABI between clerk-js core, the React isomorphicClerk wrapper, and @clerk/ui runtime calls so reviewers have a reference when changing those surfaces. Also adds a PR-template checklist item pointing at the inventory, and an empty changeset since this is docs/process only.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 21, 2026

🦋 Changeset detected

Latest commit: 48f021f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link
Copy Markdown

vercel Bot commented May 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment May 21, 2026 7:47pm

Request Review

@jacekradko jacekradko marked this pull request as ready for review May 21, 2026 19:46
@jacekradko jacekradko changed the title Add a hotload boundary ABI inventory and review gate docs(repo): add hotload boundary ABI inventory and review gate May 21, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR introduces a hotload boundary ABI inventory system to document internal Clerk and IsomorphicClerk members used across package boundaries in non-major releases. The primary documentation file (docs/hotload-boundary-abi-inventory.md) defines three boundary categories (Local-only, Released-together, Hotload-boundary), enumerates specific internal members with their provider and consumer locations, compatibility requirements, and risk levels, describes current preservation decisions for selected boundaries, and establishes a review checklist for changes to listed members. Supporting changes add a contributor reminder to the PR template and a changeset entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately captures the main objective: adding documentation for a hotload boundary ABI inventory and establishing a review process gate.
Description check ✅ Passed The PR description accurately describes the changeset, explaining the ABI inventory documentation, PR template update, and changeset file addition.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 21, 2026

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@8614

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@8614

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@8614

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@8614

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@8614

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@8614

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@8614

@clerk/express

npm i https://pkg.pr.new/@clerk/express@8614

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@8614

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8614

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@8614

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@8614

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@8614

@clerk/react

npm i https://pkg.pr.new/@clerk/react@8614

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@8614

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@8614

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@8614

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@8614

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8614

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@8614

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@8614

commit: 48f021f

@jacekradko jacekradko marked this pull request as draft May 21, 2026 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant