Skip to content

fix(repo): use canonical Dashboard links and ban legacy last-active URLs - #9653

Merged
SarahSoutoul merged 3 commits into
mainfrom
ss/DOCS-12082
Sep 4, 2026
Merged

fix(repo): use canonical Dashboard links and ban legacy last-active URLs#9653
SarahSoutoul merged 3 commits into
mainfrom
ss/DOCS-12082

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Description

Clerk Dashboard links across the SDKs still used the legacy https://dashboard.clerk.com/last-active?path=… URL. It resolves, so the docs link checker in clerk/clerk couldn't tell it apart from a broken link, and the 12 generated TypeDoc links it produced on the backend and Next.js reference pages kept passing validation.

This PR replaces every remaining /last-active link with the canonical active-instance shortcut, https://dashboard.clerk.com/~/…: the backend publishableKey, secretKey, and jwtKey JSDoc that feeds TypeDoc, the matching publishableKey JSDoc in @clerk/shared and @clerk/chrome-extension, the missing-key and billing error messages in @clerk/shared, the native API error in @clerk/expo, the keyless prompt fallback in @clerk/ui, the @clerk/express and @clerk/chrome-extension READMEs, and the core-2 upgrade guides.

It also adds scripts/check-dashboard-links.mjs, run as pnpm lint:dashboard-links in the CI pre-checks job and in pnpm lint. It scans tracked files for Dashboard URLs whose path is /last-active and fails with the /~/ replacement for each hit. It doesn't validate that a route exists; clerk/clerk keeps doing that against the Dashboard route snapshot.

The companion docs PR, https://github.com/clerk/clerk/pull/3294, syncs the generated TypeDoc output and bans /last-active on the docs side. Linear: https://linear.app/clerk/issue/DOCS-12082

Checklist

Type of change

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

@vercel

vercel Bot commented Sep 3, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
clerk-js-sandbox Ready Ready Preview Sep 4, 2026 10:04pm UTC
swingset Ready Ready Preview Sep 4, 2026 10:04pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: d69d48f

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

This PR includes changesets to release 24 packages
Name Type
@clerk/backend Patch
@clerk/chrome-extension Patch
@clerk/expo Patch
@clerk/express Patch
@clerk/shared Patch
@clerk/ui Patch
@clerk/upgrade Patch
@clerk/astro Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/clerk-js Patch
@clerk/electron Patch
@clerk/expo-passkeys Patch
@clerk/headless Patch
@clerk/localizations Patch
@clerk/msw Patch
@clerk/react Patch
@clerk/vue Patch
@clerk/swingset 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

coderabbitai Bot commented Sep 3, 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: ASSERTIVE

Plan: Team

Run ID: 953b354a-bdf2-4fe7-a0cf-bd4695f5cc15

📥 Commits

Reviewing files that changed from the base of the PR and between 3e7824d and d69d48f.

📒 Files selected for processing (21)
  • .changeset/canonical-dashboard-links.md
  • .github/workflows/ci.yml
  • integration/tests/next-quickstart-keyless.test.ts
  • package.json
  • packages/chrome-extension/README.md
  • packages/chrome-extension/docs/manifest.md
  • packages/chrome-extension/src/react/ClerkProvider.tsx
  • packages/expo/src/provider/singleton/createClerkInstance.ts
  • packages/express/README.md
  • packages/shared/src/errors/errorThrower.ts
  • packages/shared/src/internal/clerk-js/warnings.ts
  • packages/shared/src/keys.ts
  • packages/shared/src/types/clerk.ts
  • packages/ui/src/components/devPrompts/KeylessPrompt/index.tsx
  • packages/upgrade/src/guide-generators/core-2/retheme/intro.mdx
  • packages/upgrade/src/versions/core-2/common/api-key-to-secret-key.md
  • packages/upgrade/src/versions/core-2/common/clerkprovider-frontendapi-2.md
  • packages/upgrade/src/versions/core-2/common/frontend-api-to-publishable-key.md
  • scripts/check-dashboard-links.mjs
  • scripts/check-dashboard-links.test.mjs
  • scripts/lint.mjs
🔗 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) → reviewed against open PR #3294 ss/DOCS-12082 instead of the default branch

Included review availability: 7 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.


📝 Walkthrough

Walkthrough

Updated Clerk Dashboard links across runtime guidance, documentation, migration guides, and integration fixtures. Added a CLI checker with tests, package and lint integration, and a CI validation step. Added a changeset for affected packages.

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

Merge Risk: ⚪ Minimal · up to d69d4

This change updates Dashboard links and adds validation to prevent legacy URLs from returning. No merge-blocking current-head risk remains.

Suggested reviewers: nikosdouvlis, wobsoriano

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 12.50% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 8 functions across 14 files. (10 skipped:… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
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 clearly summarizes the main changes: replacing legacy Dashboard links with canonical links and preventing future use of legacy URLs.
Description check ✅ Passed The description directly explains the link updates, the new dashboard-link lint check, affected packages, validation behavior, and related documentation work.
Full details: Docstring Coverage

Explanation

Docstring coverage is 12.50% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 8 functions across 14 files. (10 skipped: 10 unsupported.)

  • Fix all pre-merge checks with AI

Warning

Linked repositories: Your configuration references 7 linked repositories, but your current plan allows 5. Analyzed clerk/clerk_go, clerk/dashboard, clerk/accounts, clerk/backoffice, clerk/clerk, skipped clerk/clerk-docs, clerk/cloudflare-workers.


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

@pkg-pr-new

pkg-pr-new Bot commented Sep 3, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: d69d48f

@SarahSoutoul SarahSoutoul changed the title Fix Dashboard API key links in TypeDoc sources feat(backend): Fix Dashboard API key links in TypeDoc sources Sep 3, 2026
@SarahSoutoul SarahSoutoul self-assigned this Sep 4, 2026
@SarahSoutoul SarahSoutoul changed the title feat(backend): Fix Dashboard API key links in TypeDoc sources docs(backend): use canonical Dashboard API key links Sep 4, 2026
@SarahSoutoul
SarahSoutoul marked this pull request as ready for review September 4, 2026 17:33
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-09-04T22:05:46.102Z

Summary

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

No API Changes Detected

All packages have stable APIs with no detected changes.


Report generated by Break Check

Last ran on d69d48f.

@manovotny manovotny self-assigned this Sep 4, 2026
Replace every remaining `dashboard.clerk.com/last-active?path=…` link in
JSDoc, error messages, READMEs, and upgrade guides with the `/~/…`
active-instance shortcut, and add `scripts/check-dashboard-links.mjs` so CI
fails on any new `/last-active` link.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@manovotny manovotny changed the title docs(backend): use canonical Dashboard API key links fix(repo): use canonical Dashboard links and ban legacy last-active URLs Sep 4, 2026
@manovotny

Copy link
Copy Markdown
Contributor

Pushed some changes directly in d69d48f.

  • Added a @clerk/backend changeset so the Require Changeset check passes, and listed the other packages touched below.
  • Replaced the 14 remaining /last-active links outside this PR's three files: the publishableKey JSDoc in @clerk/shared and @clerk/chrome-extension, the missing-key and billing error strings in @clerk/shared, the native API error in @clerk/expo, the keyless prompt fallback in @clerk/ui, the express and chrome-extension READMEs, the core-2 upgrade guides, and one integration fixture.
  • Added scripts/check-dashboard-links.mjs, wired in as pnpm lint:dashboard-links in the CI pre-checks job and in pnpm lint. It fails on any Dashboard URL whose path is /last-active and prints the /~/ replacement. No route validation; clerk/clerk keeps that.
  • Rewrote the description to the template and retitled to fix(repo) since the change now spans seven packages plus tooling.

@SarahSoutoul
SarahSoutoul merged commit 7ea009f into main Sep 4, 2026
59 checks passed
@SarahSoutoul
SarahSoutoul deleted the ss/DOCS-12082 branch September 4, 2026 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants