ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jacekradko merged 14 commits into from
Jun 1, 2026
Merged

ci(repo): extend break-check coverage to all SDK packages #8691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
be63baa
ci(repo): extend snapi coverage to all SDK packages
jacekradko May 28, 2026
3b25e30
ci(repo): format astro tsconfig.declarations.json
jacekradko May 28, 2026
7cdc34d
Merge branch 'main' into jacek/snapi-coverage-all-packages
jacekradko May 29, 2026
599e224
ci(repo): bump snapi to latest main
jacekradko May 29, 2026
c0e8d78
ci(repo): version-key snapi baseline cache and post report via github…
jacekradko May 29, 2026
b6e1c79
ci(repo): snapshot baseline with base-ref coverage and tolerate parti…
jacekradko May 29, 2026
8330b8b
ci(repo): bump snapi to latest main
jacekradko May 29, 2026
be8178c
ci(repo): rename snapi to break-check
jacekradko May 29, 2026
b3855b4
ci(repo): pin break-check current side to the PR head sha
jacekradko May 29, 2026
8d0e7c3
Merge branch 'main' into jacek/snapi-coverage-all-packages
jacekradko May 30, 2026
c87d170
ci(repo): keep baseline coverage guard for pre-rename base refs
jacekradko May 30, 2026
21e12ad
ci(repo): bump break-check pin to latest main (a4db93a)
jacekradko May 31, 2026
80083e4
chore(repo): consolidate break-check changesets into one empty changeset
jacekradko May 31, 2026
0228509
chore(repo): point astro/vue tsup onSuccess at build:declarations
jacekradko Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md
View file
Open in desktop
File renamed without changes.
196 changes: 147 additions & 49 deletions .github/workflows/api-changes.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
- release/v4
- release/core-2
paths:
- 'packages/astro/**'
- 'packages/backend/**'
- 'packages/chrome-extension/**'
- 'packages/clerk-js/**'
- 'packages/expo/**'
- 'packages/expo-passkeys/**'
- 'packages/express/**'
- 'packages/fastify/**'
- 'packages/hono/**'
- 'packages/localizations/**'
- 'packages/nextjs/**'
- 'packages/nuxt/**'
- 'packages/react/**'
- 'packages/react-router/**'
- 'packages/shared/**'
- 'packages/tanstack-react-start/**'
- 'packages/testing/**'
- 'packages/ui/**'
- 'snapi.config.json'
- 'packages/vue/**'
- 'break-check.config.json'
- '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
SNAPI_FILTERS: >-
# The tool was renamed snapi -> break-check (package @clerk/break-check, binary
# break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
# specific commit on main.
BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
BREAK_CHECK_FILTERS: >-
--filter=@clerk/astro
--filter=@clerk/backend
--filter=@clerk/chrome-extension
--filter=@clerk/clerk-js
--filter=@clerk/expo
--filter=@clerk/expo-passkeys
--filter=@clerk/express
--filter=@clerk/fastify
--filter=@clerk/hono
--filter=@clerk/localizations
--filter=@clerk/nextjs
--filter=@clerk/nuxt
--filter=@clerk/react
--filter=@clerk/react-router
--filter=@clerk/shared
--filter=@clerk/tanstack-react-start
--filter=@clerk/testing
--filter=@clerk/ui
--filter=@clerk/vue

jobs:
publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
turbo-token: ${{ secrets.TURBO_TOKEN }}

- name: Build declarations
run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

- name: Generate API snapshot
run: |
pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
--output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

- name: Resolve break-check cache key
id: break-check-key
run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

- name: Save baseline to cache
uses: actions/cache/save@v4
with:
path: .api-snapshots-baseline
key: snapi-baseline-${{ github.sha }}
# Fold the break-check commit into the key: a snapshot produced by one
# break-check version must not be reused by another, since discovery
# changes (e.g. wildcard subpath expansion) make the surfaces
# incomparable and the diff degenerates into thousands of phantom
# additions.
key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

check-api:
if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
- name: Checkout Repo
uses: actions/checkout@v4
with:
# Pin the "current" side of the diff to the PR head, not the
# refs/pull/N/merge ref checkout resolves by default. The merge ref is
# the head merged into the moving tip of the base branch, so once main
# advances it absorbs unrelated changes and break-check reports them as
# this PR's own (clerk/break-check#32). The baseline is already pinned
# to base.sha (cache key + worktree fallback below).
ref: ${{ github.event.pull_request.head.sha }}
fetch-depth: 100
fetch-tags: false
filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
turbo-team: ${{ vars.TURBO_TEAM }}
turbo-token: ${{ secrets.TURBO_TOKEN }}

- name: Resolve break-check cache key
id: break-check-key
run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

- name: Restore baseline from cache
id: baseline-cache
uses: actions/cache/restore@v4
with:
path: .api-snapshots-baseline
key: snapi-baseline-${{ github.event.pull_request.base.sha }}
# Keyed on the break-check commit too, so bumping break-check misses the
# stale baseline and the worktree fallback below rebuilds it with the
# same version the PR runs (see publish-baseline for the rationale).
key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

- name: Build current declarations
run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

- name: Fetch base commit
if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
if: steps.baseline-cache.outputs.cache-matched-key == ''
run: |
mkdir -p .worktrees
git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
# Snapshot the base ref with the coverage it actually had. Only seed the
# config when the base tracks no coverage at all; otherwise packages
# newly added to coverage in this PR get diffed against a baseline that
# never tracked them (every export reads as a phantom change against the
# base's bundled .d.ts), and the base ref may not even build their
# declarations yet. A base from before this rename still names its config
# snapi.config.json, so check both names. This reads the base's real
# coverage; it is not rename-compat, and goes no-op once main carries
# break-check.config.json.
if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
fi

- name: Install baseline dependencies
if: steps.baseline-cache.outputs.cache-matched-key == ''
working-directory: .worktrees/snapi-baseline
working-directory: .worktrees/break-check-baseline
run: pnpm install --frozen-lockfile

- name: Build baseline declarations
if: steps.baseline-cache.outputs.cache-matched-key == ''
working-directory: .worktrees/snapi-baseline
run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
working-directory: .worktrees/break-check-baseline
# --continue past per-package failures and don't fail the step: the base
# ref may not build declarations for packages that only gained
# build:declarations support in this PR. break-check snapshots only the
# base's own coverage below, so a partial build is fine; a needed package
# that fails to build still surfaces when `break-check snapshot` finds no
# .d.ts.
run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

- name: Generate baseline API snapshots
if: steps.baseline-cache.outputs.cache-matched-key == ''
working-directory: .worktrees/snapi-baseline
working-directory: .worktrees/break-check-baseline
run: |
pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
--output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

- name: Detect API changes
env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
run: |
pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
--baseline .api-snapshots-baseline \
--output api-changes-report.md \
--fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
if-no-files-found: ignore
retention-days: 5

- name: Build snapi comment body
- name: Post break-check report
if: always()
id: report
run: |
if [ ! -f api-changes-report.md ]; then
exit 0
fi
{
echo 'body<<SNAPI_REPORT_EOF'
echo '<!-- snapi-report -->'
if grep -q '## No API Changes Detected' api-changes-report.md; then
echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
else
cat api-changes-report.md
fi
echo 'SNAPI_REPORT_EOF'
} >> "$GITHUB_OUTPUT"

- name: Find existing snapi comment
if: always() && steps.report.outputs.body != ''
id: find-comment
uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
env:
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: '<!-- snapi-report -->'
script: |
const fs = require('fs');
const reportPath = 'api-changes-report.md';
if (!fs.existsSync(reportPath)) {
core.info('No break-check report found; skipping comment.');
return;
}

- name: Post snapi report
if: always() && steps.report.outputs.body != ''
uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
with:
comment-id: ${{ steps.find-comment.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: ${{ steps.report.outputs.body }}
edit-mode: replace
const marker = '<!-- break-check-report -->';
const report = fs.readFileSync(reportPath, 'utf-8');

let body;
if (report.includes('## No API Changes Detected')) {
body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
} else {
// GitHub rejects comment bodies over 65536 chars. Read the report
// from disk and post via the API so we never hit an arg-length
// limit, and truncate with a pointer to the full artifact when a
// genuinely large diff would overflow the comment.
const LIMIT = 64000;
const head = `${marker}\n`;
if (head.length + report.length <= LIMIT) {
body = head + report;
} else {
const notice =
`\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
`The full report is attached as the \`api-changes-report\` artifact on ` +
`[this run](${process.env.RUN_URL}).\n`;
const budget = LIMIT - head.length - notice.length;
body = head + report.slice(0, budget) + notice;
}
}

const comments = await github.paginate(github.rest.issues.listComments, {
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
per_page: 100,
});
const existing = comments.find(
(c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
);

if (existing) {
await github.rest.issues.updateComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
body,
});
} else {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body,
});
}
27 changes: 27 additions & 0 deletions break-check.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
"packages": [
"packages/astro",
"packages/backend",
"packages/chrome-extension",
"packages/clerk-js",
"packages/expo",
"packages/expo-passkeys",
"packages/express",
"packages/fastify",
"packages/hono",
"packages/localizations",
"packages/nextjs",
"packages/nuxt",
"packages/react",
"packages/react-router",
"packages/shared",
"packages/tanstack-react-start",
"packages/testing",
"packages/ui",
"packages/vue"
],
"snapshotDir": ".api-snapshots",
"mainBranch": "main",
"checkVersionBump": true,
"outputFormat": "markdown"
}
4 changes: 2 additions & 2 deletions packages/astro/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
"types.ts"
],
"scripts": {
"build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
"build:dts": "tsc --emitDeclarationOnly --declaration",
"build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
"build:declarations": "tsc -p tsconfig.declarations.json",
"copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
"dev": "tsup --watch",
"dev:pub": "pnpm dev -- --env.publish",
Expand Down
12 changes: 12 additions & 0 deletions packages/astro/tsconfig.declarations.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"declaration": true,
"declarationMap": true,
"emitDeclarationOnly": true,
"outDir": "./dist",
"declarationDir": "./dist/types",
"skipLibCheck": true
},
"exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}
2 changes: 1 addition & 1 deletion packages/astro/tsup.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
],
dts: true,
minify: false,
onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
define: {
PACKAGE_NAME: `"${name}"`,
PACKAGE_VERSION: `"${version}"`,
Expand Down
1 change: 1 addition & 0 deletions packages/express/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
],
"scripts": {
"build": "pnpm clean && tsup",
"build:declarations": "tsc -p tsconfig.declarations.json",
"clean": "rimraf ./dist",
"dev": "tsup --watch",
"dev:pub": "pnpm dev -- --env.publish",
Expand Down
8 changes: 8 additions & 0 deletions packages/express/tsconfig.declarations.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"emitDeclarationOnly": true,
"skipLibCheck": true
},
"exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}
1 change: 1 addition & 0 deletions packages/fastify/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
],
"scripts": {
"build": "tsup --env.NODE_ENV production",
"build:declarations": "tsc -p tsconfig.declarations.json",
"clean": "rimraf ./dist",
"dev": "tsup --watch",
"dev:pub": "pnpm dev -- --env.publish",
Expand Down
8 changes: 8 additions & 0 deletions packages/fastify/tsconfig.declarations.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"emitDeclarationOnly": true,
"skipLibCheck": true
},
"exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}
1 change: 1 addition & 0 deletions packages/hono/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
],
"scripts": {
"build": "tsup --env.NODE_ENV production",
"build:declarations": "tsc -p tsconfig.declarations.json",
"clean": "rimraf ./dist",
"dev": "tsup --watch",
"dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jacekradko
merged 14 commits into

from

Jun 1, 2026
 Merged


ci(repo): extend break-check coverage to all SDK packages
#8691
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
be63baa

ci(repo): extend snapi coverage to all SDK packages


jacekradko May 28, 2026
3b25e30

ci(repo): format astro tsconfig.declarations.json


jacekradko May 28, 2026
7cdc34d

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 29, 2026
599e224

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
c0e8d78

ci(repo): version-key snapi baseline cache and post report via github…


jacekradko May 29, 2026
b6e1c79

ci(repo): snapshot baseline with base-ref coverage and tolerate parti…


jacekradko May 29, 2026
8330b8b

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
be8178c

ci(repo): rename snapi to break-check


jacekradko May 29, 2026
b3855b4

ci(repo): pin break-check current side to the PR head sha


jacekradko May 29, 2026
8d0e7c3

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 30, 2026
c87d170

ci(repo): keep baseline coverage guard for pre-rename base refs


jacekradko May 30, 2026
21e12ad

ci(repo): bump break-check pin to latest main (a4db93a)


jacekradko May 31, 2026
80083e4

chore(repo): consolidate break-check changesets into one empty changeset


jacekradko May 31, 2026
0228509

chore(repo): point astro/vue tsup onSuccess at build:declarations


jacekradko Jun 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


0
.changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md

View file


Open in desktop


File renamed without changes.


196 changes: 147 additions & 49 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
 - release/v4
 - release/core-2
 paths:
 - 'packages/astro/**'
 - 'packages/backend/**'
 - 'packages/chrome-extension/**'
 - 'packages/clerk-js/**'
 - 'packages/expo/**'
 - 'packages/expo-passkeys/**'
 - 'packages/express/**'
 - 'packages/fastify/**'
 - 'packages/hono/**'
 - 'packages/localizations/**'
 - 'packages/nextjs/**'
 - 'packages/nuxt/**'
 - 'packages/react/**'
 - 'packages/react-router/**'
 - 'packages/shared/**'
 - 'packages/tanstack-react-start/**'
 - 'packages/testing/**'
 - 'packages/ui/**'
 - 'snapi.config.json'
 - 'packages/vue/**'
 - 'break-check.config.json'
 - '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
 cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
 SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
 SNAPI_FILTERS: >-
 # The tool was renamed snapi -> break-check (package @clerk/break-check, binary
 # break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
 # specific commit on main.
 BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
 BREAK_CHECK_FILTERS: >-
 --filter=@clerk/astro
 --filter=@clerk/backend
 --filter=@clerk/chrome-extension
 --filter=@clerk/clerk-js
 --filter=@clerk/expo
 --filter=@clerk/expo-passkeys
 --filter=@clerk/express
 --filter=@clerk/fastify
 --filter=@clerk/hono
 --filter=@clerk/localizations
 --filter=@clerk/nextjs
 --filter=@clerk/nuxt
 --filter=@clerk/react
 --filter=@clerk/react-router
 --filter=@clerk/shared
 --filter=@clerk/tanstack-react-start
 --filter=@clerk/testing
 --filter=@clerk/ui
 --filter=@clerk/vue

jobs:
 publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Build declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Generate API snapshot
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Save baseline to cache
 uses: actions/cache/save@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.sha }}
 # Fold the break-check commit into the key: a snapshot produced by one
 # break-check version must not be reused by another, since discovery
 # changes (e.g. wildcard subpath expansion) make the surfaces
 # incomparable and the diff degenerates into thousands of phantom
 # additions.
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

 check-api:
 if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
 - name: Checkout Repo
 uses: actions/checkout@v4
 with:
 # Pin the "current" side of the diff to the PR head, not the
 # refs/pull/N/merge ref checkout resolves by default. The merge ref is
 # the head merged into the moving tip of the base branch, so once main
 # advances it absorbs unrelated changes and break-check reports them as
 # this PR's own (clerk/break-check#32). The baseline is already pinned
 # to base.sha (cache key + worktree fallback below).
 ref: ${{ github.event.pull_request.head.sha }}
 fetch-depth: 100
 fetch-tags: false
 filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
 turbo-team: ${{ vars.TURBO_TEAM }}
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.event.pull_request.base.sha }}
 # Keyed on the break-check commit too, so bumping break-check misses the
 # stale baseline and the worktree fallback below rebuilds it with the
 # same version the PR runs (see publish-baseline for the rationale).
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

 - name: Build current declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
 cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
 # Snapshot the base ref with the coverage it actually had. Only seed the
 # config when the base tracks no coverage at all; otherwise packages
 # newly added to coverage in this PR get diffed against a baseline that
 # never tracked them (every export reads as a phantom change against the
 # base's bundled .d.ts), and the base ref may not even build their
 # declarations yet. A base from before this rename still names its config
 # snapi.config.json, so check both names. This reads the base's real
 # coverage; it is not rename-compat, and goes no-op once main carries
 # break-check.config.json.
 if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 - name: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 working-directory: .worktrees/break-check-baseline
 # --continue past per-package failures and don't fail the step: the base
 # ref may not build declarations for packages that only gained
 # build:declarations support in this PR. break-check snapshots only the
 # base's own coverage below, so a partial build is fine; a needed package
 # that fails to build still surfaces when `break-check snapshot` finds no
 # .d.ts.
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

 - name: Generate baseline API snapshots
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
 --baseline .api-snapshots-baseline \
 --output api-changes-report.md \
 --fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
 if-no-files-found: ignore
 retention-days: 5

 - name: Build snapi comment body
 - name: Post break-check report
 if: always()
 id: report
 run: |
 if [ ! -f api-changes-report.md ]; then
 exit 0
 fi
 {
 echo 'body<<SNAPI_REPORT_EOF'
 echo '<!-- snapi-report -->'
 if grep -q '## No API Changes Detected' api-changes-report.md; then
 echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
 else
 cat api-changes-report.md
 fi
 echo 'SNAPI_REPORT_EOF'
 } >> "$GITHUB_OUTPUT"

 - name: Find existing snapi comment
 if: always() && steps.report.outputs.body != ''
 id: find-comment
 uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 with:
 issue-number: ${{ github.event.pull_request.number }}
 comment-author: 'github-actions[bot]'
 body-includes: '<!-- snapi-report -->'
 script: |
 const fs = require('fs');
 const reportPath = 'api-changes-report.md';
 if (!fs.existsSync(reportPath)) {
 core.info('No break-check report found; skipping comment.');
 return;
 }

 - name: Post snapi report
 if: always() && steps.report.outputs.body != ''
 uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
 with:
 comment-id: ${{ steps.find-comment.outputs.comment-id }}
 issue-number: ${{ github.event.pull_request.number }}
 body: ${{ steps.report.outputs.body }}
 edit-mode: replace
 const marker = '<!-- break-check-report -->';
 const report = fs.readFileSync(reportPath, 'utf-8');

 let body;
 if (report.includes('## No API Changes Detected')) {
 body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
 } else {
 // GitHub rejects comment bodies over 65536 chars. Read the report
 // from disk and post via the API so we never hit an arg-length
 // limit, and truncate with a pointer to the full artifact when a
 // genuinely large diff would overflow the comment.
 const LIMIT = 64000;
 const head = `${marker}\n`;
 if (head.length + report.length <= LIMIT) {
 body = head + report;
 } else {
 const notice =
 `\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
 `The full report is attached as the \`api-changes-report\` artifact on ` +
 `[this run](${process.env.RUN_URL}).\n`;
 const budget = LIMIT - head.length - notice.length;
 body = head + report.slice(0, budget) + notice;
 }
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 per_page: 100,
 });
 const existing = comments.find(
 (c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
 );

 if (existing) {
 await github.rest.issues.updateComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 comment_id: existing.id,
 body,
 });
 } else {
 await github.rest.issues.createComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 body,
 });
 }

27 changes: 27 additions & 0 deletions
break-check.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
 "packages": [
 "packages/astro",
 "packages/backend",
 "packages/chrome-extension",
 "packages/clerk-js",
 "packages/expo",
 "packages/expo-passkeys",
 "packages/express",
 "packages/fastify",
 "packages/hono",
 "packages/localizations",
 "packages/nextjs",
 "packages/nuxt",
 "packages/react",
 "packages/react-router",
 "packages/shared",
 "packages/tanstack-react-start",
 "packages/testing",
 "packages/ui",
 "packages/vue"
 ],
 "snapshotDir": ".api-snapshots",
 "mainBranch": "main",
 "checkVersionBump": true,
 "outputFormat": "markdown"
}

4 changes: 2 additions & 2 deletions
packages/astro/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
 "types.ts"
 ],
 "scripts": {
 "build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
 "build:dts": "tsc --emitDeclarationOnly --declaration",
 "build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

12 changes: 12 additions & 0 deletions
packages/astro/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "declaration": true,
 "declarationMap": true,
 "emitDeclarationOnly": true,
 "outDir": "./dist",
 "declarationDir": "./dist/types",
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}

2 changes: 1 addition & 1 deletion
packages/astro/tsup.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
 ],
 dts: true,
 minify: false,
 onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
 onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
 define: {
 PACKAGE_NAME: `"${name}"`,
 PACKAGE_VERSION: `"${version}"`,
Expand Down

1 change: 1 addition & 0 deletions
packages/express/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
 ],
 "scripts": {
 "build": "pnpm clean && tsup",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/express/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/fastify/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/fastify/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/hono/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jacekradko
merged 14 commits into

from

Jun 1, 2026
 Merged


ci(repo): extend break-check coverage to all SDK packages
#8691
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
be63baa

ci(repo): extend snapi coverage to all SDK packages


jacekradko May 28, 2026
3b25e30

ci(repo): format astro tsconfig.declarations.json


jacekradko May 28, 2026
7cdc34d

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 29, 2026
599e224

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
c0e8d78

ci(repo): version-key snapi baseline cache and post report via github…


jacekradko May 29, 2026
b6e1c79

ci(repo): snapshot baseline with base-ref coverage and tolerate parti…


jacekradko May 29, 2026
8330b8b

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
be8178c

ci(repo): rename snapi to break-check


jacekradko May 29, 2026
b3855b4

ci(repo): pin break-check current side to the PR head sha


jacekradko May 29, 2026
8d0e7c3

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 30, 2026
c87d170

ci(repo): keep baseline coverage guard for pre-rename base refs


jacekradko May 30, 2026
21e12ad

ci(repo): bump break-check pin to latest main (a4db93a)


jacekradko May 31, 2026
80083e4

chore(repo): consolidate break-check changesets into one empty changeset


jacekradko May 31, 2026
0228509

chore(repo): point astro/vue tsup onSuccess at build:declarations


jacekradko Jun 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


0
.changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md

View file


Open in desktop


File renamed without changes.


196 changes: 147 additions & 49 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
 - release/v4
 - release/core-2
 paths:
 - 'packages/astro/**'
 - 'packages/backend/**'
 - 'packages/chrome-extension/**'
 - 'packages/clerk-js/**'
 - 'packages/expo/**'
 - 'packages/expo-passkeys/**'
 - 'packages/express/**'
 - 'packages/fastify/**'
 - 'packages/hono/**'
 - 'packages/localizations/**'
 - 'packages/nextjs/**'
 - 'packages/nuxt/**'
 - 'packages/react/**'
 - 'packages/react-router/**'
 - 'packages/shared/**'
 - 'packages/tanstack-react-start/**'
 - 'packages/testing/**'
 - 'packages/ui/**'
 - 'snapi.config.json'
 - 'packages/vue/**'
 - 'break-check.config.json'
 - '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
 cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
 SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
 SNAPI_FILTERS: >-
 # The tool was renamed snapi -> break-check (package @clerk/break-check, binary
 # break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
 # specific commit on main.
 BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
 BREAK_CHECK_FILTERS: >-
 --filter=@clerk/astro
 --filter=@clerk/backend
 --filter=@clerk/chrome-extension
 --filter=@clerk/clerk-js
 --filter=@clerk/expo
 --filter=@clerk/expo-passkeys
 --filter=@clerk/express
 --filter=@clerk/fastify
 --filter=@clerk/hono
 --filter=@clerk/localizations
 --filter=@clerk/nextjs
 --filter=@clerk/nuxt
 --filter=@clerk/react
 --filter=@clerk/react-router
 --filter=@clerk/shared
 --filter=@clerk/tanstack-react-start
 --filter=@clerk/testing
 --filter=@clerk/ui
 --filter=@clerk/vue

jobs:
 publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Build declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Generate API snapshot
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Save baseline to cache
 uses: actions/cache/save@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.sha }}
 # Fold the break-check commit into the key: a snapshot produced by one
 # break-check version must not be reused by another, since discovery
 # changes (e.g. wildcard subpath expansion) make the surfaces
 # incomparable and the diff degenerates into thousands of phantom
 # additions.
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

 check-api:
 if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
 - name: Checkout Repo
 uses: actions/checkout@v4
 with:
 # Pin the "current" side of the diff to the PR head, not the
 # refs/pull/N/merge ref checkout resolves by default. The merge ref is
 # the head merged into the moving tip of the base branch, so once main
 # advances it absorbs unrelated changes and break-check reports them as
 # this PR's own (clerk/break-check#32). The baseline is already pinned
 # to base.sha (cache key + worktree fallback below).
 ref: ${{ github.event.pull_request.head.sha }}
 fetch-depth: 100
 fetch-tags: false
 filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
 turbo-team: ${{ vars.TURBO_TEAM }}
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.event.pull_request.base.sha }}
 # Keyed on the break-check commit too, so bumping break-check misses the
 # stale baseline and the worktree fallback below rebuilds it with the
 # same version the PR runs (see publish-baseline for the rationale).
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

 - name: Build current declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
 cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
 # Snapshot the base ref with the coverage it actually had. Only seed the
 # config when the base tracks no coverage at all; otherwise packages
 # newly added to coverage in this PR get diffed against a baseline that
 # never tracked them (every export reads as a phantom change against the
 # base's bundled .d.ts), and the base ref may not even build their
 # declarations yet. A base from before this rename still names its config
 # snapi.config.json, so check both names. This reads the base's real
 # coverage; it is not rename-compat, and goes no-op once main carries
 # break-check.config.json.
 if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 - name: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 working-directory: .worktrees/break-check-baseline
 # --continue past per-package failures and don't fail the step: the base
 # ref may not build declarations for packages that only gained
 # build:declarations support in this PR. break-check snapshots only the
 # base's own coverage below, so a partial build is fine; a needed package
 # that fails to build still surfaces when `break-check snapshot` finds no
 # .d.ts.
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

 - name: Generate baseline API snapshots
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
 --baseline .api-snapshots-baseline \
 --output api-changes-report.md \
 --fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
 if-no-files-found: ignore
 retention-days: 5

 - name: Build snapi comment body
 - name: Post break-check report
 if: always()
 id: report
 run: |
 if [ ! -f api-changes-report.md ]; then
 exit 0
 fi
 {
 echo 'body<<SNAPI_REPORT_EOF'
 echo '<!-- snapi-report -->'
 if grep -q '## No API Changes Detected' api-changes-report.md; then
 echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
 else
 cat api-changes-report.md
 fi
 echo 'SNAPI_REPORT_EOF'
 } >> "$GITHUB_OUTPUT"

 - name: Find existing snapi comment
 if: always() && steps.report.outputs.body != ''
 id: find-comment
 uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 with:
 issue-number: ${{ github.event.pull_request.number }}
 comment-author: 'github-actions[bot]'
 body-includes: '<!-- snapi-report -->'
 script: |
 const fs = require('fs');
 const reportPath = 'api-changes-report.md';
 if (!fs.existsSync(reportPath)) {
 core.info('No break-check report found; skipping comment.');
 return;
 }

 - name: Post snapi report
 if: always() && steps.report.outputs.body != ''
 uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
 with:
 comment-id: ${{ steps.find-comment.outputs.comment-id }}
 issue-number: ${{ github.event.pull_request.number }}
 body: ${{ steps.report.outputs.body }}
 edit-mode: replace
 const marker = '<!-- break-check-report -->';
 const report = fs.readFileSync(reportPath, 'utf-8');

 let body;
 if (report.includes('## No API Changes Detected')) {
 body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
 } else {
 // GitHub rejects comment bodies over 65536 chars. Read the report
 // from disk and post via the API so we never hit an arg-length
 // limit, and truncate with a pointer to the full artifact when a
 // genuinely large diff would overflow the comment.
 const LIMIT = 64000;
 const head = `${marker}\n`;
 if (head.length + report.length <= LIMIT) {
 body = head + report;
 } else {
 const notice =
 `\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
 `The full report is attached as the \`api-changes-report\` artifact on ` +
 `[this run](${process.env.RUN_URL}).\n`;
 const budget = LIMIT - head.length - notice.length;
 body = head + report.slice(0, budget) + notice;
 }
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 per_page: 100,
 });
 const existing = comments.find(
 (c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
 );

 if (existing) {
 await github.rest.issues.updateComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 comment_id: existing.id,
 body,
 });
 } else {
 await github.rest.issues.createComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 body,
 });
 }

27 changes: 27 additions & 0 deletions
break-check.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
 "packages": [
 "packages/astro",
 "packages/backend",
 "packages/chrome-extension",
 "packages/clerk-js",
 "packages/expo",
 "packages/expo-passkeys",
 "packages/express",
 "packages/fastify",
 "packages/hono",
 "packages/localizations",
 "packages/nextjs",
 "packages/nuxt",
 "packages/react",
 "packages/react-router",
 "packages/shared",
 "packages/tanstack-react-start",
 "packages/testing",
 "packages/ui",
 "packages/vue"
 ],
 "snapshotDir": ".api-snapshots",
 "mainBranch": "main",
 "checkVersionBump": true,
 "outputFormat": "markdown"
}

4 changes: 2 additions & 2 deletions
packages/astro/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
 "types.ts"
 ],
 "scripts": {
 "build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
 "build:dts": "tsc --emitDeclarationOnly --declaration",
 "build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

12 changes: 12 additions & 0 deletions
packages/astro/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "declaration": true,
 "declarationMap": true,
 "emitDeclarationOnly": true,
 "outDir": "./dist",
 "declarationDir": "./dist/types",
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}

2 changes: 1 addition & 1 deletion
packages/astro/tsup.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
 ],
 dts: true,
 minify: false,
 onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
 onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
 define: {
 PACKAGE_NAME: `"${name}"`,
 PACKAGE_VERSION: `"${version}"`,
Expand Down

1 change: 1 addition & 0 deletions
packages/express/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
 ],
 "scripts": {
 "build": "pnpm clean && tsup",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/express/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/fastify/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/fastify/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/hono/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jacekradko
merged 14 commits into

from

Jun 1, 2026
 Merged


ci(repo): extend break-check coverage to all SDK packages
#8691
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
be63baa

ci(repo): extend snapi coverage to all SDK packages


jacekradko May 28, 2026
3b25e30

ci(repo): format astro tsconfig.declarations.json


jacekradko May 28, 2026
7cdc34d

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 29, 2026
599e224

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
c0e8d78

ci(repo): version-key snapi baseline cache and post report via github…


jacekradko May 29, 2026
b6e1c79

ci(repo): snapshot baseline with base-ref coverage and tolerate parti…


jacekradko May 29, 2026
8330b8b

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
be8178c

ci(repo): rename snapi to break-check


jacekradko May 29, 2026
b3855b4

ci(repo): pin break-check current side to the PR head sha


jacekradko May 29, 2026
8d0e7c3

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 30, 2026
c87d170

ci(repo): keep baseline coverage guard for pre-rename base refs


jacekradko May 30, 2026
21e12ad

ci(repo): bump break-check pin to latest main (a4db93a)


jacekradko May 31, 2026
80083e4

chore(repo): consolidate break-check changesets into one empty changeset


jacekradko May 31, 2026
0228509

chore(repo): point astro/vue tsup onSuccess at build:declarations


jacekradko Jun 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


0
.changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md

View file


Open in desktop


File renamed without changes.


196 changes: 147 additions & 49 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
 - release/v4
 - release/core-2
 paths:
 - 'packages/astro/**'
 - 'packages/backend/**'
 - 'packages/chrome-extension/**'
 - 'packages/clerk-js/**'
 - 'packages/expo/**'
 - 'packages/expo-passkeys/**'
 - 'packages/express/**'
 - 'packages/fastify/**'
 - 'packages/hono/**'
 - 'packages/localizations/**'
 - 'packages/nextjs/**'
 - 'packages/nuxt/**'
 - 'packages/react/**'
 - 'packages/react-router/**'
 - 'packages/shared/**'
 - 'packages/tanstack-react-start/**'
 - 'packages/testing/**'
 - 'packages/ui/**'
 - 'snapi.config.json'
 - 'packages/vue/**'
 - 'break-check.config.json'
 - '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
 cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
 SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
 SNAPI_FILTERS: >-
 # The tool was renamed snapi -> break-check (package @clerk/break-check, binary
 # break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
 # specific commit on main.
 BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
 BREAK_CHECK_FILTERS: >-
 --filter=@clerk/astro
 --filter=@clerk/backend
 --filter=@clerk/chrome-extension
 --filter=@clerk/clerk-js
 --filter=@clerk/expo
 --filter=@clerk/expo-passkeys
 --filter=@clerk/express
 --filter=@clerk/fastify
 --filter=@clerk/hono
 --filter=@clerk/localizations
 --filter=@clerk/nextjs
 --filter=@clerk/nuxt
 --filter=@clerk/react
 --filter=@clerk/react-router
 --filter=@clerk/shared
 --filter=@clerk/tanstack-react-start
 --filter=@clerk/testing
 --filter=@clerk/ui
 --filter=@clerk/vue

jobs:
 publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Build declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Generate API snapshot
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Save baseline to cache
 uses: actions/cache/save@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.sha }}
 # Fold the break-check commit into the key: a snapshot produced by one
 # break-check version must not be reused by another, since discovery
 # changes (e.g. wildcard subpath expansion) make the surfaces
 # incomparable and the diff degenerates into thousands of phantom
 # additions.
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

 check-api:
 if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
 - name: Checkout Repo
 uses: actions/checkout@v4
 with:
 # Pin the "current" side of the diff to the PR head, not the
 # refs/pull/N/merge ref checkout resolves by default. The merge ref is
 # the head merged into the moving tip of the base branch, so once main
 # advances it absorbs unrelated changes and break-check reports them as
 # this PR's own (clerk/break-check#32). The baseline is already pinned
 # to base.sha (cache key + worktree fallback below).
 ref: ${{ github.event.pull_request.head.sha }}
 fetch-depth: 100
 fetch-tags: false
 filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
 turbo-team: ${{ vars.TURBO_TEAM }}
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.event.pull_request.base.sha }}
 # Keyed on the break-check commit too, so bumping break-check misses the
 # stale baseline and the worktree fallback below rebuilds it with the
 # same version the PR runs (see publish-baseline for the rationale).
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

 - name: Build current declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
 cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
 # Snapshot the base ref with the coverage it actually had. Only seed the
 # config when the base tracks no coverage at all; otherwise packages
 # newly added to coverage in this PR get diffed against a baseline that
 # never tracked them (every export reads as a phantom change against the
 # base's bundled .d.ts), and the base ref may not even build their
 # declarations yet. A base from before this rename still names its config
 # snapi.config.json, so check both names. This reads the base's real
 # coverage; it is not rename-compat, and goes no-op once main carries
 # break-check.config.json.
 if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 - name: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 working-directory: .worktrees/break-check-baseline
 # --continue past per-package failures and don't fail the step: the base
 # ref may not build declarations for packages that only gained
 # build:declarations support in this PR. break-check snapshots only the
 # base's own coverage below, so a partial build is fine; a needed package
 # that fails to build still surfaces when `break-check snapshot` finds no
 # .d.ts.
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

 - name: Generate baseline API snapshots
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
 --baseline .api-snapshots-baseline \
 --output api-changes-report.md \
 --fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
 if-no-files-found: ignore
 retention-days: 5

 - name: Build snapi comment body
 - name: Post break-check report
 if: always()
 id: report
 run: |
 if [ ! -f api-changes-report.md ]; then
 exit 0
 fi
 {
 echo 'body<<SNAPI_REPORT_EOF'
 echo '<!-- snapi-report -->'
 if grep -q '## No API Changes Detected' api-changes-report.md; then
 echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
 else
 cat api-changes-report.md
 fi
 echo 'SNAPI_REPORT_EOF'
 } >> "$GITHUB_OUTPUT"

 - name: Find existing snapi comment
 if: always() && steps.report.outputs.body != ''
 id: find-comment
 uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 with:
 issue-number: ${{ github.event.pull_request.number }}
 comment-author: 'github-actions[bot]'
 body-includes: '<!-- snapi-report -->'
 script: |
 const fs = require('fs');
 const reportPath = 'api-changes-report.md';
 if (!fs.existsSync(reportPath)) {
 core.info('No break-check report found; skipping comment.');
 return;
 }

 - name: Post snapi report
 if: always() && steps.report.outputs.body != ''
 uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
 with:
 comment-id: ${{ steps.find-comment.outputs.comment-id }}
 issue-number: ${{ github.event.pull_request.number }}
 body: ${{ steps.report.outputs.body }}
 edit-mode: replace
 const marker = '<!-- break-check-report -->';
 const report = fs.readFileSync(reportPath, 'utf-8');

 let body;
 if (report.includes('## No API Changes Detected')) {
 body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
 } else {
 // GitHub rejects comment bodies over 65536 chars. Read the report
 // from disk and post via the API so we never hit an arg-length
 // limit, and truncate with a pointer to the full artifact when a
 // genuinely large diff would overflow the comment.
 const LIMIT = 64000;
 const head = `${marker}\n`;
 if (head.length + report.length <= LIMIT) {
 body = head + report;
 } else {
 const notice =
 `\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
 `The full report is attached as the \`api-changes-report\` artifact on ` +
 `[this run](${process.env.RUN_URL}).\n`;
 const budget = LIMIT - head.length - notice.length;
 body = head + report.slice(0, budget) + notice;
 }
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 per_page: 100,
 });
 const existing = comments.find(
 (c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
 );

 if (existing) {
 await github.rest.issues.updateComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 comment_id: existing.id,
 body,
 });
 } else {
 await github.rest.issues.createComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 body,
 });
 }

27 changes: 27 additions & 0 deletions
break-check.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
 "packages": [
 "packages/astro",
 "packages/backend",
 "packages/chrome-extension",
 "packages/clerk-js",
 "packages/expo",
 "packages/expo-passkeys",
 "packages/express",
 "packages/fastify",
 "packages/hono",
 "packages/localizations",
 "packages/nextjs",
 "packages/nuxt",
 "packages/react",
 "packages/react-router",
 "packages/shared",
 "packages/tanstack-react-start",
 "packages/testing",
 "packages/ui",
 "packages/vue"
 ],
 "snapshotDir": ".api-snapshots",
 "mainBranch": "main",
 "checkVersionBump": true,
 "outputFormat": "markdown"
}

4 changes: 2 additions & 2 deletions
packages/astro/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
 "types.ts"
 ],
 "scripts": {
 "build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
 "build:dts": "tsc --emitDeclarationOnly --declaration",
 "build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

12 changes: 12 additions & 0 deletions
packages/astro/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "declaration": true,
 "declarationMap": true,
 "emitDeclarationOnly": true,
 "outDir": "./dist",
 "declarationDir": "./dist/types",
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}

2 changes: 1 addition & 1 deletion
packages/astro/tsup.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
 ],
 dts: true,
 minify: false,
 onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
 onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
 define: {
 PACKAGE_NAME: `"${name}"`,
 PACKAGE_VERSION: `"${version}"`,
Expand Down

1 change: 1 addition & 0 deletions
packages/express/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
 ],
 "scripts": {
 "build": "pnpm clean && tsup",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/express/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/fastify/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/fastify/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/hono/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jacekradko
merged 14 commits into

from

Jun 1, 2026
 Merged


ci(repo): extend break-check coverage to all SDK packages
#8691
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
be63baa

ci(repo): extend snapi coverage to all SDK packages


jacekradko May 28, 2026
3b25e30

ci(repo): format astro tsconfig.declarations.json


jacekradko May 28, 2026
7cdc34d

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 29, 2026
599e224

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
c0e8d78

ci(repo): version-key snapi baseline cache and post report via github…


jacekradko May 29, 2026
b6e1c79

ci(repo): snapshot baseline with base-ref coverage and tolerate parti…


jacekradko May 29, 2026
8330b8b

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
be8178c

ci(repo): rename snapi to break-check


jacekradko May 29, 2026
b3855b4

ci(repo): pin break-check current side to the PR head sha


jacekradko May 29, 2026
8d0e7c3

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 30, 2026
c87d170

ci(repo): keep baseline coverage guard for pre-rename base refs


jacekradko May 30, 2026
21e12ad

ci(repo): bump break-check pin to latest main (a4db93a)


jacekradko May 31, 2026
80083e4

chore(repo): consolidate break-check changesets into one empty changeset


jacekradko May 31, 2026
0228509

chore(repo): point astro/vue tsup onSuccess at build:declarations


jacekradko Jun 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


0
.changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md

View file


Open in desktop


File renamed without changes.


196 changes: 147 additions & 49 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
 - release/v4
 - release/core-2
 paths:
 - 'packages/astro/**'
 - 'packages/backend/**'
 - 'packages/chrome-extension/**'
 - 'packages/clerk-js/**'
 - 'packages/expo/**'
 - 'packages/expo-passkeys/**'
 - 'packages/express/**'
 - 'packages/fastify/**'
 - 'packages/hono/**'
 - 'packages/localizations/**'
 - 'packages/nextjs/**'
 - 'packages/nuxt/**'
 - 'packages/react/**'
 - 'packages/react-router/**'
 - 'packages/shared/**'
 - 'packages/tanstack-react-start/**'
 - 'packages/testing/**'
 - 'packages/ui/**'
 - 'snapi.config.json'
 - 'packages/vue/**'
 - 'break-check.config.json'
 - '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
 cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
 SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
 SNAPI_FILTERS: >-
 # The tool was renamed snapi -> break-check (package @clerk/break-check, binary
 # break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
 # specific commit on main.
 BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
 BREAK_CHECK_FILTERS: >-
 --filter=@clerk/astro
 --filter=@clerk/backend
 --filter=@clerk/chrome-extension
 --filter=@clerk/clerk-js
 --filter=@clerk/expo
 --filter=@clerk/expo-passkeys
 --filter=@clerk/express
 --filter=@clerk/fastify
 --filter=@clerk/hono
 --filter=@clerk/localizations
 --filter=@clerk/nextjs
 --filter=@clerk/nuxt
 --filter=@clerk/react
 --filter=@clerk/react-router
 --filter=@clerk/shared
 --filter=@clerk/tanstack-react-start
 --filter=@clerk/testing
 --filter=@clerk/ui
 --filter=@clerk/vue

jobs:
 publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Build declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Generate API snapshot
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Save baseline to cache
 uses: actions/cache/save@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.sha }}
 # Fold the break-check commit into the key: a snapshot produced by one
 # break-check version must not be reused by another, since discovery
 # changes (e.g. wildcard subpath expansion) make the surfaces
 # incomparable and the diff degenerates into thousands of phantom
 # additions.
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

 check-api:
 if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
 - name: Checkout Repo
 uses: actions/checkout@v4
 with:
 # Pin the "current" side of the diff to the PR head, not the
 # refs/pull/N/merge ref checkout resolves by default. The merge ref is
 # the head merged into the moving tip of the base branch, so once main
 # advances it absorbs unrelated changes and break-check reports them as
 # this PR's own (clerk/break-check#32). The baseline is already pinned
 # to base.sha (cache key + worktree fallback below).
 ref: ${{ github.event.pull_request.head.sha }}
 fetch-depth: 100
 fetch-tags: false
 filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
 turbo-team: ${{ vars.TURBO_TEAM }}
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.event.pull_request.base.sha }}
 # Keyed on the break-check commit too, so bumping break-check misses the
 # stale baseline and the worktree fallback below rebuilds it with the
 # same version the PR runs (see publish-baseline for the rationale).
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

 - name: Build current declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
 cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
 # Snapshot the base ref with the coverage it actually had. Only seed the
 # config when the base tracks no coverage at all; otherwise packages
 # newly added to coverage in this PR get diffed against a baseline that
 # never tracked them (every export reads as a phantom change against the
 # base's bundled .d.ts), and the base ref may not even build their
 # declarations yet. A base from before this rename still names its config
 # snapi.config.json, so check both names. This reads the base's real
 # coverage; it is not rename-compat, and goes no-op once main carries
 # break-check.config.json.
 if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 - name: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 working-directory: .worktrees/break-check-baseline
 # --continue past per-package failures and don't fail the step: the base
 # ref may not build declarations for packages that only gained
 # build:declarations support in this PR. break-check snapshots only the
 # base's own coverage below, so a partial build is fine; a needed package
 # that fails to build still surfaces when `break-check snapshot` finds no
 # .d.ts.
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

 - name: Generate baseline API snapshots
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
 --baseline .api-snapshots-baseline \
 --output api-changes-report.md \
 --fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
 if-no-files-found: ignore
 retention-days: 5

 - name: Build snapi comment body
 - name: Post break-check report
 if: always()
 id: report
 run: |
 if [ ! -f api-changes-report.md ]; then
 exit 0
 fi
 {
 echo 'body<<SNAPI_REPORT_EOF'
 echo '<!-- snapi-report -->'
 if grep -q '## No API Changes Detected' api-changes-report.md; then
 echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
 else
 cat api-changes-report.md
 fi
 echo 'SNAPI_REPORT_EOF'
 } >> "$GITHUB_OUTPUT"

 - name: Find existing snapi comment
 if: always() && steps.report.outputs.body != ''
 id: find-comment
 uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 with:
 issue-number: ${{ github.event.pull_request.number }}
 comment-author: 'github-actions[bot]'
 body-includes: '<!-- snapi-report -->'
 script: |
 const fs = require('fs');
 const reportPath = 'api-changes-report.md';
 if (!fs.existsSync(reportPath)) {
 core.info('No break-check report found; skipping comment.');
 return;
 }

 - name: Post snapi report
 if: always() && steps.report.outputs.body != ''
 uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
 with:
 comment-id: ${{ steps.find-comment.outputs.comment-id }}
 issue-number: ${{ github.event.pull_request.number }}
 body: ${{ steps.report.outputs.body }}
 edit-mode: replace
 const marker = '<!-- break-check-report -->';
 const report = fs.readFileSync(reportPath, 'utf-8');

 let body;
 if (report.includes('## No API Changes Detected')) {
 body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
 } else {
 // GitHub rejects comment bodies over 65536 chars. Read the report
 // from disk and post via the API so we never hit an arg-length
 // limit, and truncate with a pointer to the full artifact when a
 // genuinely large diff would overflow the comment.
 const LIMIT = 64000;
 const head = `${marker}\n`;
 if (head.length + report.length <= LIMIT) {
 body = head + report;
 } else {
 const notice =
 `\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
 `The full report is attached as the \`api-changes-report\` artifact on ` +
 `[this run](${process.env.RUN_URL}).\n`;
 const budget = LIMIT - head.length - notice.length;
 body = head + report.slice(0, budget) + notice;
 }
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 per_page: 100,
 });
 const existing = comments.find(
 (c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
 );

 if (existing) {
 await github.rest.issues.updateComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 comment_id: existing.id,
 body,
 });
 } else {
 await github.rest.issues.createComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 body,
 });
 }

27 changes: 27 additions & 0 deletions
break-check.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
 "packages": [
 "packages/astro",
 "packages/backend",
 "packages/chrome-extension",
 "packages/clerk-js",
 "packages/expo",
 "packages/expo-passkeys",
 "packages/express",
 "packages/fastify",
 "packages/hono",
 "packages/localizations",
 "packages/nextjs",
 "packages/nuxt",
 "packages/react",
 "packages/react-router",
 "packages/shared",
 "packages/tanstack-react-start",
 "packages/testing",
 "packages/ui",
 "packages/vue"
 ],
 "snapshotDir": ".api-snapshots",
 "mainBranch": "main",
 "checkVersionBump": true,
 "outputFormat": "markdown"
}

4 changes: 2 additions & 2 deletions
packages/astro/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
 "types.ts"
 ],
 "scripts": {
 "build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
 "build:dts": "tsc --emitDeclarationOnly --declaration",
 "build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

12 changes: 12 additions & 0 deletions
packages/astro/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "declaration": true,
 "declarationMap": true,
 "emitDeclarationOnly": true,
 "outDir": "./dist",
 "declarationDir": "./dist/types",
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}

2 changes: 1 addition & 1 deletion
packages/astro/tsup.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
 ],
 dts: true,
 minify: false,
 onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
 onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
 define: {
 PACKAGE_NAME: `"${name}"`,
 PACKAGE_VERSION: `"${version}"`,
Expand Down

1 change: 1 addition & 0 deletions
packages/express/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
 ],
 "scripts": {
 "build": "pnpm clean && tsup",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/express/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/fastify/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/fastify/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/hono/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jacekradko
merged 14 commits into

from

Jun 1, 2026
 Merged


ci(repo): extend break-check coverage to all SDK packages
#8691
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
be63baa

ci(repo): extend snapi coverage to all SDK packages


jacekradko May 28, 2026
3b25e30

ci(repo): format astro tsconfig.declarations.json


jacekradko May 28, 2026
7cdc34d

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 29, 2026
599e224

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
c0e8d78

ci(repo): version-key snapi baseline cache and post report via github…


jacekradko May 29, 2026
b6e1c79

ci(repo): snapshot baseline with base-ref coverage and tolerate parti…


jacekradko May 29, 2026
8330b8b

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
be8178c

ci(repo): rename snapi to break-check


jacekradko May 29, 2026
b3855b4

ci(repo): pin break-check current side to the PR head sha


jacekradko May 29, 2026
8d0e7c3

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 30, 2026
c87d170

ci(repo): keep baseline coverage guard for pre-rename base refs


jacekradko May 30, 2026
21e12ad

ci(repo): bump break-check pin to latest main (a4db93a)


jacekradko May 31, 2026
80083e4

chore(repo): consolidate break-check changesets into one empty changeset


jacekradko May 31, 2026
0228509

chore(repo): point astro/vue tsup onSuccess at build:declarations


jacekradko Jun 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


0
.changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md

View file


Open in desktop


File renamed without changes.


196 changes: 147 additions & 49 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
 - release/v4
 - release/core-2
 paths:
 - 'packages/astro/**'
 - 'packages/backend/**'
 - 'packages/chrome-extension/**'
 - 'packages/clerk-js/**'
 - 'packages/expo/**'
 - 'packages/expo-passkeys/**'
 - 'packages/express/**'
 - 'packages/fastify/**'
 - 'packages/hono/**'
 - 'packages/localizations/**'
 - 'packages/nextjs/**'
 - 'packages/nuxt/**'
 - 'packages/react/**'
 - 'packages/react-router/**'
 - 'packages/shared/**'
 - 'packages/tanstack-react-start/**'
 - 'packages/testing/**'
 - 'packages/ui/**'
 - 'snapi.config.json'
 - 'packages/vue/**'
 - 'break-check.config.json'
 - '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
 cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
 SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
 SNAPI_FILTERS: >-
 # The tool was renamed snapi -> break-check (package @clerk/break-check, binary
 # break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
 # specific commit on main.
 BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
 BREAK_CHECK_FILTERS: >-
 --filter=@clerk/astro
 --filter=@clerk/backend
 --filter=@clerk/chrome-extension
 --filter=@clerk/clerk-js
 --filter=@clerk/expo
 --filter=@clerk/expo-passkeys
 --filter=@clerk/express
 --filter=@clerk/fastify
 --filter=@clerk/hono
 --filter=@clerk/localizations
 --filter=@clerk/nextjs
 --filter=@clerk/nuxt
 --filter=@clerk/react
 --filter=@clerk/react-router
 --filter=@clerk/shared
 --filter=@clerk/tanstack-react-start
 --filter=@clerk/testing
 --filter=@clerk/ui
 --filter=@clerk/vue

jobs:
 publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Build declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Generate API snapshot
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Save baseline to cache
 uses: actions/cache/save@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.sha }}
 # Fold the break-check commit into the key: a snapshot produced by one
 # break-check version must not be reused by another, since discovery
 # changes (e.g. wildcard subpath expansion) make the surfaces
 # incomparable and the diff degenerates into thousands of phantom
 # additions.
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

 check-api:
 if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
 - name: Checkout Repo
 uses: actions/checkout@v4
 with:
 # Pin the "current" side of the diff to the PR head, not the
 # refs/pull/N/merge ref checkout resolves by default. The merge ref is
 # the head merged into the moving tip of the base branch, so once main
 # advances it absorbs unrelated changes and break-check reports them as
 # this PR's own (clerk/break-check#32). The baseline is already pinned
 # to base.sha (cache key + worktree fallback below).
 ref: ${{ github.event.pull_request.head.sha }}
 fetch-depth: 100
 fetch-tags: false
 filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
 turbo-team: ${{ vars.TURBO_TEAM }}
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.event.pull_request.base.sha }}
 # Keyed on the break-check commit too, so bumping break-check misses the
 # stale baseline and the worktree fallback below rebuilds it with the
 # same version the PR runs (see publish-baseline for the rationale).
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

 - name: Build current declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
 cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
 # Snapshot the base ref with the coverage it actually had. Only seed the
 # config when the base tracks no coverage at all; otherwise packages
 # newly added to coverage in this PR get diffed against a baseline that
 # never tracked them (every export reads as a phantom change against the
 # base's bundled .d.ts), and the base ref may not even build their
 # declarations yet. A base from before this rename still names its config
 # snapi.config.json, so check both names. This reads the base's real
 # coverage; it is not rename-compat, and goes no-op once main carries
 # break-check.config.json.
 if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 - name: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 working-directory: .worktrees/break-check-baseline
 # --continue past per-package failures and don't fail the step: the base
 # ref may not build declarations for packages that only gained
 # build:declarations support in this PR. break-check snapshots only the
 # base's own coverage below, so a partial build is fine; a needed package
 # that fails to build still surfaces when `break-check snapshot` finds no
 # .d.ts.
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

 - name: Generate baseline API snapshots
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
 --baseline .api-snapshots-baseline \
 --output api-changes-report.md \
 --fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
 if-no-files-found: ignore
 retention-days: 5

 - name: Build snapi comment body
 - name: Post break-check report
 if: always()
 id: report
 run: |
 if [ ! -f api-changes-report.md ]; then
 exit 0
 fi
 {
 echo 'body<<SNAPI_REPORT_EOF'
 echo '<!-- snapi-report -->'
 if grep -q '## No API Changes Detected' api-changes-report.md; then
 echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
 else
 cat api-changes-report.md
 fi
 echo 'SNAPI_REPORT_EOF'
 } >> "$GITHUB_OUTPUT"

 - name: Find existing snapi comment
 if: always() && steps.report.outputs.body != ''
 id: find-comment
 uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 with:
 issue-number: ${{ github.event.pull_request.number }}
 comment-author: 'github-actions[bot]'
 body-includes: '<!-- snapi-report -->'
 script: |
 const fs = require('fs');
 const reportPath = 'api-changes-report.md';
 if (!fs.existsSync(reportPath)) {
 core.info('No break-check report found; skipping comment.');
 return;
 }

 - name: Post snapi report
 if: always() && steps.report.outputs.body != ''
 uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
 with:
 comment-id: ${{ steps.find-comment.outputs.comment-id }}
 issue-number: ${{ github.event.pull_request.number }}
 body: ${{ steps.report.outputs.body }}
 edit-mode: replace
 const marker = '<!-- break-check-report -->';
 const report = fs.readFileSync(reportPath, 'utf-8');

 let body;
 if (report.includes('## No API Changes Detected')) {
 body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
 } else {
 // GitHub rejects comment bodies over 65536 chars. Read the report
 // from disk and post via the API so we never hit an arg-length
 // limit, and truncate with a pointer to the full artifact when a
 // genuinely large diff would overflow the comment.
 const LIMIT = 64000;
 const head = `${marker}\n`;
 if (head.length + report.length <= LIMIT) {
 body = head + report;
 } else {
 const notice =
 `\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
 `The full report is attached as the \`api-changes-report\` artifact on ` +
 `[this run](${process.env.RUN_URL}).\n`;
 const budget = LIMIT - head.length - notice.length;
 body = head + report.slice(0, budget) + notice;
 }
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 per_page: 100,
 });
 const existing = comments.find(
 (c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
 );

 if (existing) {
 await github.rest.issues.updateComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 comment_id: existing.id,
 body,
 });
 } else {
 await github.rest.issues.createComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 body,
 });
 }

27 changes: 27 additions & 0 deletions
break-check.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
 "packages": [
 "packages/astro",
 "packages/backend",
 "packages/chrome-extension",
 "packages/clerk-js",
 "packages/expo",
 "packages/expo-passkeys",
 "packages/express",
 "packages/fastify",
 "packages/hono",
 "packages/localizations",
 "packages/nextjs",
 "packages/nuxt",
 "packages/react",
 "packages/react-router",
 "packages/shared",
 "packages/tanstack-react-start",
 "packages/testing",
 "packages/ui",
 "packages/vue"
 ],
 "snapshotDir": ".api-snapshots",
 "mainBranch": "main",
 "checkVersionBump": true,
 "outputFormat": "markdown"
}

4 changes: 2 additions & 2 deletions
packages/astro/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
 "types.ts"
 ],
 "scripts": {
 "build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
 "build:dts": "tsc --emitDeclarationOnly --declaration",
 "build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

12 changes: 12 additions & 0 deletions
packages/astro/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "declaration": true,
 "declarationMap": true,
 "emitDeclarationOnly": true,
 "outDir": "./dist",
 "declarationDir": "./dist/types",
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}

2 changes: 1 addition & 1 deletion
packages/astro/tsup.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
 ],
 dts: true,
 minify: false,
 onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
 onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
 define: {
 PACKAGE_NAME: `"${name}"`,
 PACKAGE_VERSION: `"${version}"`,
Expand Down

1 change: 1 addition & 0 deletions
packages/express/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
 ],
 "scripts": {
 "build": "pnpm clean && tsup",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/express/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/fastify/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/fastify/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/hono/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jacekradko
merged 14 commits into

from

Jun 1, 2026
 Merged


ci(repo): extend break-check coverage to all SDK packages
#8691
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
be63baa

ci(repo): extend snapi coverage to all SDK packages


jacekradko May 28, 2026
3b25e30

ci(repo): format astro tsconfig.declarations.json


jacekradko May 28, 2026
7cdc34d

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 29, 2026
599e224

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
c0e8d78

ci(repo): version-key snapi baseline cache and post report via github…


jacekradko May 29, 2026
b6e1c79

ci(repo): snapshot baseline with base-ref coverage and tolerate parti…


jacekradko May 29, 2026
8330b8b

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
be8178c

ci(repo): rename snapi to break-check


jacekradko May 29, 2026
b3855b4

ci(repo): pin break-check current side to the PR head sha


jacekradko May 29, 2026
8d0e7c3

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 30, 2026
c87d170

ci(repo): keep baseline coverage guard for pre-rename base refs


jacekradko May 30, 2026
21e12ad

ci(repo): bump break-check pin to latest main (a4db93a)


jacekradko May 31, 2026
80083e4

chore(repo): consolidate break-check changesets into one empty changeset


jacekradko May 31, 2026
0228509

chore(repo): point astro/vue tsup onSuccess at build:declarations


jacekradko Jun 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


0
.changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md

View file


Open in desktop


File renamed without changes.


196 changes: 147 additions & 49 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
 - release/v4
 - release/core-2
 paths:
 - 'packages/astro/**'
 - 'packages/backend/**'
 - 'packages/chrome-extension/**'
 - 'packages/clerk-js/**'
 - 'packages/expo/**'
 - 'packages/expo-passkeys/**'
 - 'packages/express/**'
 - 'packages/fastify/**'
 - 'packages/hono/**'
 - 'packages/localizations/**'
 - 'packages/nextjs/**'
 - 'packages/nuxt/**'
 - 'packages/react/**'
 - 'packages/react-router/**'
 - 'packages/shared/**'
 - 'packages/tanstack-react-start/**'
 - 'packages/testing/**'
 - 'packages/ui/**'
 - 'snapi.config.json'
 - 'packages/vue/**'
 - 'break-check.config.json'
 - '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
 cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
 SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
 SNAPI_FILTERS: >-
 # The tool was renamed snapi -> break-check (package @clerk/break-check, binary
 # break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
 # specific commit on main.
 BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
 BREAK_CHECK_FILTERS: >-
 --filter=@clerk/astro
 --filter=@clerk/backend
 --filter=@clerk/chrome-extension
 --filter=@clerk/clerk-js
 --filter=@clerk/expo
 --filter=@clerk/expo-passkeys
 --filter=@clerk/express
 --filter=@clerk/fastify
 --filter=@clerk/hono
 --filter=@clerk/localizations
 --filter=@clerk/nextjs
 --filter=@clerk/nuxt
 --filter=@clerk/react
 --filter=@clerk/react-router
 --filter=@clerk/shared
 --filter=@clerk/tanstack-react-start
 --filter=@clerk/testing
 --filter=@clerk/ui
 --filter=@clerk/vue

jobs:
 publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Build declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Generate API snapshot
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Save baseline to cache
 uses: actions/cache/save@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.sha }}
 # Fold the break-check commit into the key: a snapshot produced by one
 # break-check version must not be reused by another, since discovery
 # changes (e.g. wildcard subpath expansion) make the surfaces
 # incomparable and the diff degenerates into thousands of phantom
 # additions.
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

 check-api:
 if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
 - name: Checkout Repo
 uses: actions/checkout@v4
 with:
 # Pin the "current" side of the diff to the PR head, not the
 # refs/pull/N/merge ref checkout resolves by default. The merge ref is
 # the head merged into the moving tip of the base branch, so once main
 # advances it absorbs unrelated changes and break-check reports them as
 # this PR's own (clerk/break-check#32). The baseline is already pinned
 # to base.sha (cache key + worktree fallback below).
 ref: ${{ github.event.pull_request.head.sha }}
 fetch-depth: 100
 fetch-tags: false
 filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
 turbo-team: ${{ vars.TURBO_TEAM }}
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.event.pull_request.base.sha }}
 # Keyed on the break-check commit too, so bumping break-check misses the
 # stale baseline and the worktree fallback below rebuilds it with the
 # same version the PR runs (see publish-baseline for the rationale).
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

 - name: Build current declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
 cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
 # Snapshot the base ref with the coverage it actually had. Only seed the
 # config when the base tracks no coverage at all; otherwise packages
 # newly added to coverage in this PR get diffed against a baseline that
 # never tracked them (every export reads as a phantom change against the
 # base's bundled .d.ts), and the base ref may not even build their
 # declarations yet. A base from before this rename still names its config
 # snapi.config.json, so check both names. This reads the base's real
 # coverage; it is not rename-compat, and goes no-op once main carries
 # break-check.config.json.
 if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 - name: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 working-directory: .worktrees/break-check-baseline
 # --continue past per-package failures and don't fail the step: the base
 # ref may not build declarations for packages that only gained
 # build:declarations support in this PR. break-check snapshots only the
 # base's own coverage below, so a partial build is fine; a needed package
 # that fails to build still surfaces when `break-check snapshot` finds no
 # .d.ts.
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

 - name: Generate baseline API snapshots
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
 --baseline .api-snapshots-baseline \
 --output api-changes-report.md \
 --fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
 if-no-files-found: ignore
 retention-days: 5

 - name: Build snapi comment body
 - name: Post break-check report
 if: always()
 id: report
 run: |
 if [ ! -f api-changes-report.md ]; then
 exit 0
 fi
 {
 echo 'body<<SNAPI_REPORT_EOF'
 echo '<!-- snapi-report -->'
 if grep -q '## No API Changes Detected' api-changes-report.md; then
 echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
 else
 cat api-changes-report.md
 fi
 echo 'SNAPI_REPORT_EOF'
 } >> "$GITHUB_OUTPUT"

 - name: Find existing snapi comment
 if: always() && steps.report.outputs.body != ''
 id: find-comment
 uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 with:
 issue-number: ${{ github.event.pull_request.number }}
 comment-author: 'github-actions[bot]'
 body-includes: '<!-- snapi-report -->'
 script: |
 const fs = require('fs');
 const reportPath = 'api-changes-report.md';
 if (!fs.existsSync(reportPath)) {
 core.info('No break-check report found; skipping comment.');
 return;
 }

 - name: Post snapi report
 if: always() && steps.report.outputs.body != ''
 uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
 with:
 comment-id: ${{ steps.find-comment.outputs.comment-id }}
 issue-number: ${{ github.event.pull_request.number }}
 body: ${{ steps.report.outputs.body }}
 edit-mode: replace
 const marker = '<!-- break-check-report -->';
 const report = fs.readFileSync(reportPath, 'utf-8');

 let body;
 if (report.includes('## No API Changes Detected')) {
 body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
 } else {
 // GitHub rejects comment bodies over 65536 chars. Read the report
 // from disk and post via the API so we never hit an arg-length
 // limit, and truncate with a pointer to the full artifact when a
 // genuinely large diff would overflow the comment.
 const LIMIT = 64000;
 const head = `${marker}\n`;
 if (head.length + report.length <= LIMIT) {
 body = head + report;
 } else {
 const notice =
 `\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
 `The full report is attached as the \`api-changes-report\` artifact on ` +
 `[this run](${process.env.RUN_URL}).\n`;
 const budget = LIMIT - head.length - notice.length;
 body = head + report.slice(0, budget) + notice;
 }
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 per_page: 100,
 });
 const existing = comments.find(
 (c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
 );

 if (existing) {
 await github.rest.issues.updateComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 comment_id: existing.id,
 body,
 });
 } else {
 await github.rest.issues.createComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 body,
 });
 }

27 changes: 27 additions & 0 deletions
break-check.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
 "packages": [
 "packages/astro",
 "packages/backend",
 "packages/chrome-extension",
 "packages/clerk-js",
 "packages/expo",
 "packages/expo-passkeys",
 "packages/express",
 "packages/fastify",
 "packages/hono",
 "packages/localizations",
 "packages/nextjs",
 "packages/nuxt",
 "packages/react",
 "packages/react-router",
 "packages/shared",
 "packages/tanstack-react-start",
 "packages/testing",
 "packages/ui",
 "packages/vue"
 ],
 "snapshotDir": ".api-snapshots",
 "mainBranch": "main",
 "checkVersionBump": true,
 "outputFormat": "markdown"
}

4 changes: 2 additions & 2 deletions
packages/astro/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
 "types.ts"
 ],
 "scripts": {
 "build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
 "build:dts": "tsc --emitDeclarationOnly --declaration",
 "build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

12 changes: 12 additions & 0 deletions
packages/astro/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "declaration": true,
 "declarationMap": true,
 "emitDeclarationOnly": true,
 "outDir": "./dist",
 "declarationDir": "./dist/types",
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}

2 changes: 1 addition & 1 deletion
packages/astro/tsup.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
 ],
 dts: true,
 minify: false,
 onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
 onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
 define: {
 PACKAGE_NAME: `"${name}"`,
 PACKAGE_VERSION: `"${version}"`,
Expand Down

1 change: 1 addition & 0 deletions
packages/express/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
 ],
 "scripts": {
 "build": "pnpm clean && tsup",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/express/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/fastify/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/fastify/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/hono/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ci(repo): extend break-check coverage to all SDK packages#8691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jacekradko
merged 14 commits into

from

Jun 1, 2026
 Merged


ci(repo): extend break-check coverage to all SDK packages
#8691
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
be63baa

ci(repo): extend snapi coverage to all SDK packages


jacekradko May 28, 2026
3b25e30

ci(repo): format astro tsconfig.declarations.json


jacekradko May 28, 2026
7cdc34d

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 29, 2026
599e224

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
c0e8d78

ci(repo): version-key snapi baseline cache and post report via github…


jacekradko May 29, 2026
b6e1c79

ci(repo): snapshot baseline with base-ref coverage and tolerate parti…


jacekradko May 29, 2026
8330b8b

ci(repo): bump snapi to latest main


jacekradko May 29, 2026
be8178c

ci(repo): rename snapi to break-check


jacekradko May 29, 2026
b3855b4

ci(repo): pin break-check current side to the PR head sha


jacekradko May 29, 2026
8d0e7c3

Merge branch 'main' into jacek/snapi-coverage-all-packages


jacekradko May 30, 2026
c87d170

ci(repo): keep baseline coverage guard for pre-rename base refs


jacekradko May 30, 2026
21e12ad

ci(repo): bump break-check pin to latest main (a4db93a)


jacekradko May 31, 2026
80083e4

chore(repo): consolidate break-check changesets into one empty changeset


jacekradko May 31, 2026
0228509

chore(repo): point astro/vue tsup onSuccess at build:declarations


jacekradko Jun 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


0
.changeset/snapi-bump-version.md → ...eset/break-check-coverage-all-packages.md

View file


Open in desktop


File renamed without changes.


196 changes: 147 additions & 49 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,26 @@ on:
 - release/v4
 - release/core-2
 paths:
 - 'packages/astro/**'
 - 'packages/backend/**'
 - 'packages/chrome-extension/**'
 - 'packages/clerk-js/**'
 - 'packages/expo/**'
 - 'packages/expo-passkeys/**'
 - 'packages/express/**'
 - 'packages/fastify/**'
 - 'packages/hono/**'
 - 'packages/localizations/**'
 - 'packages/nextjs/**'
 - 'packages/nuxt/**'
 - 'packages/react/**'
 - 'packages/react-router/**'
 - 'packages/shared/**'
 - 'packages/tanstack-react-start/**'
 - 'packages/testing/**'
 - 'packages/ui/**'
 - 'snapi.config.json'
 - 'packages/vue/**'
 - 'break-check.config.json'
 - '.github/workflows/api-changes.yml'

permissions:
Expand All@@ -30,14 +43,30 @@ concurrency:
 cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
 SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@2479ffce1adb8ff5f1caf95509268774224c121d
 SNAPI_FILTERS: >-
 # The tool was renamed snapi -> break-check (package @clerk/break-check, binary
 # break-check, repo clerk/break-check). Pinned to a pkg.pr.new build of a
 # specific commit on main.
 BREAK_CHECK_PACKAGE: https://pkg.pr.new/clerk/break-check/@clerk/break-check@a4db93a68e43e45a71cc958cc4a722d91c5f62b2
 BREAK_CHECK_FILTERS: >-
 --filter=@clerk/astro
 --filter=@clerk/backend
 --filter=@clerk/chrome-extension
 --filter=@clerk/clerk-js
 --filter=@clerk/expo
 --filter=@clerk/expo-passkeys
 --filter=@clerk/express
 --filter=@clerk/fastify
 --filter=@clerk/hono
 --filter=@clerk/localizations
 --filter=@clerk/nextjs
 --filter=@clerk/nuxt
 --filter=@clerk/react
 --filter=@clerk/react-router
 --filter=@clerk/shared
 --filter=@clerk/tanstack-react-start
 --filter=@clerk/testing
 --filter=@clerk/ui
 --filter=@clerk/vue

jobs:
 publish-baseline:
Expand DownExpand Up@@ -66,18 +95,27 @@ jobs:
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Build declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Generate API snapshot
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Save baseline to cache
 uses: actions/cache/save@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.sha }}
 # Fold the break-check commit into the key: a snapshot produced by one
 # break-check version must not be reused by another, since discovery
 # changes (e.g. wildcard subpath expansion) make the surfaces
 # incomparable and the diff degenerates into thousands of phantom
 # additions.
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.sha }}

 check-api:
 if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }}
Expand All@@ -96,6 +134,13 @@ jobs:
 - name: Checkout Repo
 uses: actions/checkout@v4
 with:
 # Pin the "current" side of the diff to the PR head, not the
 # refs/pull/N/merge ref checkout resolves by default. The merge ref is
 # the head merged into the moving tip of the base branch, so once main
 # advances it absorbs unrelated changes and break-check reports them as
 # this PR's own (clerk/break-check#32). The baseline is already pinned
 # to base.sha (cache key + worktree fallback below).
 ref: ${{ github.event.pull_request.head.sha }}
 fetch-depth: 100
 fetch-tags: false
 filter: 'blob:none'
Expand All@@ -109,15 +154,22 @@ jobs:
 turbo-team: ${{ vars.TURBO_TEAM }}
 turbo-token: ${{ secrets.TURBO_TOKEN }}

 - name: Resolve break-check cache key
 id: break-check-key
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 key: snapi-baseline-${{ github.event.pull_request.base.sha }}
 # Keyed on the break-check commit too, so bumping break-check misses the
 # stale baseline and the worktree fallback below rebuilds it with the
 # same version the PR runs (see publish-baseline for the rationale).
 key: break-check-baseline-${{ steps.break-check-key.outputs.ref }}-${{ github.event.pull_request.base.sha }}

 - name: Build current declarations
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
Expand All@@ -127,31 +179,48 @@ jobs:
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}"
 cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
 # Snapshot the base ref with the coverage it actually had. Only seed the
 # config when the base tracks no coverage at all; otherwise packages
 # newly added to coverage in this PR get diffed against a baseline that
 # never tracked them (every export reads as a phantom change against the
 # base's bundled .d.ts), and the base ref may not even build their
 # declarations yet. A base from before this rename still names its config
 # snapi.config.json, so check both names. This reads the base's real
 # coverage; it is not rename-compat, and goes no-op once main carries
 # break-check.config.json.
 if [ ! -f .worktrees/break-check-baseline/break-check.config.json ] && [ ! -f .worktrees/break-check-baseline/snapi.config.json ]; then
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 - name: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS
 working-directory: .worktrees/break-check-baseline
 # --continue past per-package failures and don't fail the step: the base
 # ref may not build declarations for packages that only gained
 # build:declarations support in this PR. break-check snapshots only the
 # base's own coverage below, so a partial build is fine; a needed package
 # that fails to build still surfaces when `break-check snapshot` finds no
 # .d.ts.
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS --continue || true

 - name: Generate baseline API snapshots
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/snapi-baseline
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 env:
SNAPI_ANTHROPIC_API_KEY: ${{ secrets.SNAPI_ANTHROPIC_API_KEY }}
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
 pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check detect \
 --baseline .api-snapshots-baseline \
 --output api-changes-report.md \
 --fail-on-breaking
Expand All@@ -165,38 +234,67 @@ jobs:
 if-no-files-found: ignore
 retention-days: 5

 - name: Build snapi comment body
 - name: Post break-check report
 if: always()
 id: report
 run: |
 if [ ! -f api-changes-report.md ]; then
 exit 0
 fi
 {
 echo 'body<<SNAPI_REPORT_EOF'
 echo '<!-- snapi-report -->'
 if grep -q '## No API Changes Detected' api-changes-report.md; then
 echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.'
 else
 cat api-changes-report.md
 fi
 echo 'SNAPI_REPORT_EOF'
 } >> "$GITHUB_OUTPUT"

 - name: Find existing snapi comment
 if: always() && steps.report.outputs.body != ''
 id: find-comment
 uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 with:
 issue-number: ${{ github.event.pull_request.number }}
 comment-author: 'github-actions[bot]'
 body-includes: '<!-- snapi-report -->'
 script: |
 const fs = require('fs');
 const reportPath = 'api-changes-report.md';
 if (!fs.existsSync(reportPath)) {
 core.info('No break-check report found; skipping comment.');
 return;
 }

 - name: Post snapi report
 if: always() && steps.report.outputs.body != ''
 uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0
 with:
 comment-id: ${{ steps.find-comment.outputs.comment-id }}
 issue-number: ${{ github.event.pull_request.number }}
 body: ${{ steps.report.outputs.body }}
 edit-mode: replace
 const marker = '<!-- break-check-report -->';
 const report = fs.readFileSync(reportPath, 'utf-8');

 let body;
 if (report.includes('## No API Changes Detected')) {
 body = `${marker}\n**Break Check**: no API changes detected across the tracked packages.`;
 } else {
 // GitHub rejects comment bodies over 65536 chars. Read the report
 // from disk and post via the API so we never hit an arg-length
 // limit, and truncate with a pointer to the full artifact when a
 // genuinely large diff would overflow the comment.
 const LIMIT = 64000;
 const head = `${marker}\n`;
 if (head.length + report.length <= LIMIT) {
 body = head + report;
 } else {
 const notice =
 `\n\n> **Note**\n> Report truncated to fit GitHub's comment limit. ` +
 `The full report is attached as the \`api-changes-report\` artifact on ` +
 `[this run](${process.env.RUN_URL}).\n`;
 const budget = LIMIT - head.length - notice.length;
 body = head + report.slice(0, budget) + notice;
 }
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 per_page: 100,
 });
 const existing = comments.find(
 (c) => c.user?.type === 'Bot' && c.body && c.body.includes(marker),
 );

 if (existing) {
 await github.rest.issues.updateComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 comment_id: existing.id,
 body,
 });
 } else {
 await github.rest.issues.createComment({
 owner: context.repo.owner,
 repo: context.repo.repo,
 issue_number: context.issue.number,
 body,
 });
 }

27 changes: 27 additions & 0 deletions
break-check.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
{
 "packages": [
 "packages/astro",
 "packages/backend",
 "packages/chrome-extension",
 "packages/clerk-js",
 "packages/expo",
 "packages/expo-passkeys",
 "packages/express",
 "packages/fastify",
 "packages/hono",
 "packages/localizations",
 "packages/nextjs",
 "packages/nuxt",
 "packages/react",
 "packages/react-router",
 "packages/shared",
 "packages/tanstack-react-start",
 "packages/testing",
 "packages/ui",
 "packages/vue"
 ],
 "snapshotDir": ".api-snapshots",
 "mainBranch": "main",
 "checkVersionBump": true,
 "outputFormat": "markdown"
}

4 changes: 2 additions & 2 deletions
packages/astro/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,8 +77,8 @@
 "types.ts"
 ],
 "scripts": {
 "build": "tsup --onSuccess \"pnpm build:dts\" && pnpm copy:components",
 "build:dts": "tsc --emitDeclarationOnly --declaration",
 "build": "tsup --onSuccess \"pnpm build:declarations\" && pnpm copy:components",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "copy:components": "rm -rf ./components && mkdir -p ./components/ && cp -r ./src/astro-components/* ./components/ && cp ./src/types.ts ./",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

12 changes: 12 additions & 0 deletions
packages/astro/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "declaration": true,
 "declarationMap": true,
 "emitDeclarationOnly": true,
 "outDir": "./dist",
 "declarationDir": "./dist/types",
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "build", "src/astro-components/**/*.ts", "**/__tests__/**/*"]
}

2 changes: 1 addition & 1 deletion
packages/astro/tsup.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export default defineConfig(overrideOptions => {
 ],
 dts: true,
 minify: false,
 onSuccess: shouldPublish ? 'pnpm build:dts && pkglab pub --ping' : 'pnpm build:dts',
 onSuccess: shouldPublish ? 'pnpm build:declarations && pkglab pub --ping' : 'pnpm build:declarations',
 define: {
 PACKAGE_NAME: `"${name}"`,
 PACKAGE_VERSION: `"${version}"`,
Expand Down

1 change: 1 addition & 0 deletions
packages/express/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@
 ],
 "scripts": {
 "build": "pnpm clean && tsup",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/express/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/fastify/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down

8 changes: 8 additions & 0 deletions
packages/fastify/tsconfig.declarations.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
 "extends": "./tsconfig.json",
 "compilerOptions": {
 "emitDeclarationOnly": true,
 "skipLibCheck": true
 },
 "exclude": ["node_modules", "dist", "**/__tests__/**/*"]
}

1 change: 1 addition & 0 deletions
packages/hono/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@
 ],
 "scripts": {
 "build": "tsup --env.NODE_ENV production",
 "build:declarations": "tsc -p tsconfig.declarations.json",
 "clean": "rimraf ./dist",
 "dev": "tsup --watch",
 "dev:pub": "pnpm dev -- --env.publish",
Expand Down
Loading
Loading