Skip to content

chore(react): Remove internal and experimental JSDoc tags on signal hooks#7999

Merged
wobsoriano merged 2 commits intomainfrom
rob/remove-experimental-signals
Mar 5, 2026
Merged

chore(react): Remove internal and experimental JSDoc tags on signal hooks#7999
wobsoriano merged 2 commits intomainfrom
rob/remove-experimental-signals

Conversation

@wobsoriano
Copy link
Member

@wobsoriano wobsoriano commented Mar 5, 2026

Description

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • Documentation
    • Removed experimental status markers from signal hooks documentation. The useSignIn, useSignUp, and useWaitlist hooks are now officially promoted to stable status. These hooks are fully supported and production-ready for integration, allowing developers to implement them confidently without concerns about future breaking changes or discontinuation.

@vercel
Copy link

vercel bot commented Mar 5, 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 Mar 5, 2026 7:22pm

Request Review

@changeset-bot
Copy link

changeset-bot bot commented Mar 5, 2026

🦋 Changeset detected

Latest commit: f3843c0

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

This PR includes changesets to release 6 packages
Name Type
@clerk/react Patch
@clerk/chrome-extension Patch
@clerk/expo Patch
@clerk/nextjs Patch
@clerk/react-router Patch
@clerk/tanstack-react-start Patch

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2026

📝 Walkthrough

Walkthrough

This pull request removes experimental and internal JSDoc annotations from signal hooks in the @clerk/react package. Specifically, the @internal and @experimental markers are stripped from the documentation comments of the useSignIn, useSignUp, and useWaitlist hooks in packages/react/src/hooks/useClerkSignal.ts. A corresponding changeset entry is added to record this as a patch-level change. No runtime logic, control flow, or exported function signatures are modified by these changes.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: removing internal and experimental JSDoc tags from signal hooks in the React package, which aligns with the changeset and modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
.changeset/jolly-parents-refuse.md (1)

5-5: Consider clarifying the description to mention both tag types.

The description mentions "experimental tags" but according to the AI summary, both @internal and @experimental JSDoc tags are being removed. Consider updating to "Remove internal and experimental tags on signal hooks" for accuracy.

📝 Suggested clarification
-Remove experimental tags on signal hooks
+Remove internal and experimental tags on signal hooks
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.changeset/jolly-parents-refuse.md at line 5, Update the changeset
description text that currently reads "Remove experimental tags on signal hooks"
to explicitly mention both JSDoc tag types by changing it to "Remove internal
and experimental tags on signal hooks" so the summary accurately reflects
removal of both `@internal` and `@experimental` tags; locate the string in the
.changeset/jolly-parents-refuse.md file and replace it accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.changeset/jolly-parents-refuse.md:
- Line 5: Update the changeset description text that currently reads "Remove
experimental tags on signal hooks" to explicitly mention both JSDoc tag types by
changing it to "Remove internal and experimental tags on signal hooks" so the
summary accurately reflects removal of both `@internal` and `@experimental` tags;
locate the string in the .changeset/jolly-parents-refuse.md file and replace it
accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: fbc3d833-5f76-4fe7-9c72-80fc92506816

📥 Commits

Reviewing files that changed from the base of the PR and between e13fc29 and f3843c0.

📒 Files selected for processing (2)
  • .changeset/jolly-parents-refuse.md
  • packages/react/src/hooks/useClerkSignal.ts
💤 Files with no reviewable changes (1)
  • packages/react/src/hooks/useClerkSignal.ts

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 5, 2026

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@7999

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: f3843c0

@wobsoriano wobsoriano enabled auto-merge (squash) March 5, 2026 19:36
@wobsoriano wobsoriano merged commit 398b7f9 into main Mar 5, 2026
67 of 68 checks passed
@wobsoriano wobsoriano deleted the rob/remove-experimental-signals branch March 5, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants