Skip to content

fix(repo): link SSO bypass allowlist resource - #9997

Merged
SarahSoutoul merged 1 commit into
mainfrom
ss/DOCS-12221
Sep 30, 2026
Merged

SarahSoutoul merged 1 commit into
mainfrom
ss/DOCS-12221

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Description

DOCS-12221

Link OrganizationResource.ssoBypassAllowlist to the /docs/reference/types/sso-bypass-allowlist-resource in generated TypeDoc. The URL mapping points to the hand-authored page in clerk/clerk#3471. The @generateWithEmptyComment tag makes the interface linkable; without it, TypeDoc renders the type name as plain code.

Important

Merge order: Merge this PR before clerk/clerk#3471, and allow the TypeDoc sync to generate the updated OrganizationResource output before merging the docs PR.

To verify, run pnpm typedoc:generate:skip-build and inspect shared/organization-resource/properties.mdx. This documentation-only change has an empty changeset.

Checklist

Type of change

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

@vercel

vercel Bot commented Sep 30, 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 30, 2026 6:38pm UTC
swingset Ready Ready Preview Sep 30, 2026 6:38pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Sep 30, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a1a6558

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

@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

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: fdf013fa-7678-48ad-9a63-c92ba4e75fda

📥 Commits

Reviewing files that changed from the base of the PR and between 6dbf9a4 and a1a6558.

📒 Files selected for processing (3)
  • .changeset/shaggy-paws-tease.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/ssoBypassAllowlist.ts
🔗 Linked repositories identified

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

Included review availability: This review used your included allowance. 8 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.


📝 Walkthrough

Walkthrough

The SSOBypassAllowlistResource type now has the @generateWithEmptyComment annotation. The TypeDoc plugin maps sso-bypass-allowlist-resource to its reference documentation path. The changeset file contains only empty frontmatter delimiters.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to a1a65

The documentation-linking changes are consistent with the stated intent and introduce no identified merge-blocking risk.

🚥 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. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2…
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 change: linking the SSO bypass allowlist resource in generated TypeDoc.
Description check ✅ Passed The description explains the TypeDoc link update, the required annotation, verification steps, merge order, and documentation scope.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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

@pkg-pr-new

pkg-pr-new Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@9997

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a1a6558

@SarahSoutoul SarahSoutoul changed the title docs(typedoc): link SSO bypass allowlist resource fix(repo): link SSO bypass allowlist resource Sep 30, 2026
@SarahSoutoul SarahSoutoul self-assigned this Sep 30, 2026
@SarahSoutoul
SarahSoutoul marked this pull request as ready for review September 30, 2026 18:44
@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-09-30T18:48:49.857Z

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 a1a6558.

@SarahSoutoul
SarahSoutoul merged commit ec008f6 into main Sep 30, 2026
88 of 96 checks passed
@SarahSoutoul
SarahSoutoul deleted the ss/DOCS-12221 branch September 30, 2026 20:26

This branch was successfully deployed

2 active deployments
Preview – swingset — a1a6558a Deployed Sep 30, 2026 by vercel[bot]
Preview – clerk-js-sandbox — a1a6558a Deployed Sep 30, 2026 by vercel[bot]
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.

2 participants