Skip to content

feat: Added error with docs URL in Core 3 for <SignedIn> and <SignedOut> - #9273

Open
royanger wants to merge 2 commits into
mainfrom
ra/add-url-to-signedin-signedout-error
Open

feat: Added error with docs URL in Core 3 for <SignedIn> and <SignedOut>#9273
royanger wants to merge 2 commits into
mainfrom
ra/add-url-to-signedin-signedout-error

Conversation

@royanger

Copy link
Copy Markdown
Member

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:

@changeset-bot

changeset-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 805673e

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

This PR includes changesets to release 1 package
Name Type
@clerk/nextjs 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

@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Jul 29, 2026 5:05pm
swingset Ready Ready Preview, Comment Jul 29, 2026 5:05pm

Request Review

@github-actions

github-actions Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-29T17:07:01.910Z

Summary

Metric Count
Packages analyzed 19
Packages with changes 1
🔴 Breaking changes 0
🟡 Non-breaking changes 0
🟢 Additions 3

@clerk/nextjs

Current version: 7.6.2
Recommended bump: MINOR → 7.7.0

🟢 Additions (3)

Added: Protect

+ export declare function Protect(_props: RemovedControlComponentProps): never;

Added function Protect

Added: SignedIn

+ export declare function SignedIn(_props: RemovedControlComponentProps): never;

Added function SignedIn

Added: SignedOut

+ export declare function SignedOut(_props: RemovedControlComponentProps): never;

Added function SignedOut


Report generated by Break Check

Last ran on 805673e.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 74b42d82-9832-4c80-83c8-bd6d9cabe7cf

📥 Commits

Reviewing files that changed from the base of the PR and between 23417ef and 805673e.

📒 Files selected for processing (4)
  • .changeset/signed-in-signed-out-protect-error.md
  • packages/nextjs/src/__tests__/removedControlComponents.test.ts
  • packages/nextjs/src/index.ts
  • packages/nextjs/src/removedControlComponents.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go (manual)
  • clerk/dashboard (manual)
  • clerk/accounts (manual)
  • clerk/backoffice (manual)
  • clerk/clerk (manual)
  • clerk/clerk-docs (manual)
  • clerk/cloudflare-workers (manual)
  • clerk/cli (auto-detected)
  • clerk/clerk-ios (auto-detected)
  • clerk/clerk-android (auto-detected)
🚧 Files skipped from review as they are similar to previous changes (3)
  • packages/nextjs/src/index.ts
  • packages/nextjs/src/tests/removedControlComponents.test.ts
  • packages/nextjs/src/removedControlComponents.ts

📝 Walkthrough

Walkthrough

Adds runtime migration-error placeholders for the removed SignedIn, SignedOut, and Protect components, re-exports them from @clerk/nextjs, and verifies their errors with tests. A patch changeset documents the new behavior.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is a template and does not describe the actual code changes. Replace the template with a brief summary of the changed components, added error behavior, and any testing performed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main change: Core 3 now throws docs-link errors for removed Clerk control components.
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Fix failing CI checks

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
packages/nextjs/src/__tests__/removedControlComponents.test.ts (1)

3-17: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Cover the public package export.

These tests bypass packages/nextjs/src/index.ts, so a broken @clerk/nextjs re-export could pass. Add a small API-surface test importing SignedIn and SignedOut through the package entrypoint.

As per coding guidelines, new functionality should include comprehensive coverage.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/nextjs/src/__tests__/removedControlComponents.test.ts` around lines
3 - 17, Extend the tests in “removed control components” to import SignedIn and
SignedOut through the public package entrypoint exposed by
packages/nextjs/src/index.ts, and add API-surface assertions that both exports
retain the same docs-linked throwing behavior. Keep the existing direct-module
tests intact while ensuring the package re-exports are exercised.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@packages/nextjs/src/__tests__/removedControlComponents.test.ts`:
- Around line 3-17: Extend the tests in “removed control components” to import
SignedIn and SignedOut through the public package entrypoint exposed by
packages/nextjs/src/index.ts, and add API-surface assertions that both exports
retain the same docs-linked throwing behavior. Keep the existing direct-module
tests intact while ensuring the package re-exports are exercised.

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 7157b661-6b9a-4959-b697-027193ce9ee7

📥 Commits

Reviewing files that changed from the base of the PR and between a8f6e89 and 23417ef.

📒 Files selected for processing (4)
  • .changeset/signed-in-signed-out-error.md
  • packages/nextjs/src/__tests__/removedControlComponents.test.ts
  • packages/nextjs/src/index.ts
  • packages/nextjs/src/removedControlComponents.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • clerk/clerk_go (manual)
  • clerk/dashboard (manual)
  • clerk/accounts (manual)
  • clerk/backoffice (manual)
  • clerk/clerk (manual)
  • clerk/clerk-docs (manual)
  • clerk/cloudflare-workers (manual)
  • clerk/cli (auto-detected)
  • clerk/clerk-ios (auto-detected)
  • clerk/clerk-android (auto-detected)

@pkg-pr-new

pkg-pr-new Bot commented Jul 29, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9273

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9273

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9273

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9273

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 805673e

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.

1 participant