Skip to content

feat(repo): add snapi for api breaking changes detection#7670

Open
jacekradko wants to merge 3 commits intomainfrom
jradko/snapi-setup
Open

feat(repo): add snapi for api breaking changes detection#7670
jacekradko wants to merge 3 commits intomainfrom
jradko/snapi-setup

Conversation

@jacekradko
Copy link
Member

@jacekradko jacekradko commented Jan 24, 2026 •
edited by coderabbitai bot
Loading

Summary

Adds @clerk/snapi as a dev dependency for detecting API breaking changes in TypeScript packages.

  • Installs snapi from GitHub (clerk/snapi)
  • Adds snapi.config.json with core packages to analyze:
    • @clerk/backend
    • @clerk/clerk-js
    • @clerk/express
    • @clerk/fastify
    • @clerk/nextjs
    • @clerk/react
    • @clerk/shared
    • @clerk/vue

Usage

# Generate API snapshots
pnpm snapi snapshot

# Compare against baseline
pnpm snapi detect --baseline .api-snapshots-baseline

Next Steps

  • Add GitHub Actions workflow for PR checks
  • Publish @clerk/snapi to npm for easier installation

Test Plan

  • Verified pnpm snapi --version works
  • Verified pnpm snapi snapshot generates snapshots for all configured packages

Summary by CodeRabbit

  • Chores
    • Added development tooling and configuration to support API snapshot generation across workspace packages.
    • Updated development dependencies to include the snapshot tool.
    • Updated ignore rules to exclude generated API snapshot files from source control.

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Jan 24, 2026 •
edited
Loading

⚠️ No Changeset found

Latest commit: f226dd6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

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

Click here to learn what changesets are, and how to add one.

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

@vercel
Copy link

vercel bot commented Jan 24, 2026 •
edited
Loading

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

Project Deployment Review Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Jan 24, 2026 4:16am

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 24, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Adds configuration and setup for the snapi API snapshot tool: a new snapi.config.json (defines workspace packages, snapshotDir = ".api-snapshots", mainBranch = "main", checkVersionBump = true, outputFormat = "markdown"), adds @clerk/snapi to devDependencies in package.json (URL source), and updates .gitignore to exclude the .api-snapshots/ directory and *.api.md files. No other source or runtime logic 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.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately summarizes the main change: adding snapi for API breaking changes detection across the repository packages.

✏️ 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

pkg-pr-new bot commented Jan 24, 2026 •
edited
Loading

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: f226dd6

@jacekradko jacekradko changed the title feat: add snapi for API breaking changes detection feat(repo): add snapi for API breaking changes detection Jan 24, 2026
@jacekradko jacekradko changed the title feat(repo): add snapi for API breaking changes detection feat(repo): add snapi for api breaking changes detection Jan 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

core-3

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jacekradko