ci(repo): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into from
Jun 3, 2026
Merged

ci(repo): gate api-changes detect on turbo cache-hit signal #8723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab067b9
ci(repo): gate api-changes detect on turbo cache-hit signal
jacekradko Jun 2, 2026
dcdbd30
Merge branch 'main' into jacek/gate-api-changes-turbo-cache
jacekradko Jun 2, 2026
0313d87
ci(repo): compare api gate hashes to base
jacekradko Jun 2, 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
2 changes: 2 additions & 0 deletions .changeset/gate-api-changes-turbo-cache.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
144 changes: 122 additions & 22 deletions .github/workflows/api-changes.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
# 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 $BREAK_CHECK_FILTERS

- name: Fetch base commit
if: steps.baseline-cache.outputs.cache-matched-key == ''
run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

- name: Create baseline worktree
if: steps.baseline-cache.outputs.cache-matched-key == ''
run: |
mkdir -p .worktrees
git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
fi

# Gate the expensive snapshot/detect work on turbo's content hashing, but compare
# the PR head against the pinned base SHA. A cache HIT only means an output already
# exists for the task hash; it does not prove the PR matches its base.
- name: Determine API surface changed
id: gate
env:
BASE_SHA: ${{ github.event.pull_request.base.sha }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
run: |
node <<'EOF'
const cp = require('child_process');
const fs = require('fs');
const path = require('path');

const workspace = process.env.GITHUB_WORKSPACE;
const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
const turbo = path.join(workspace, 'node_modules/.bin/turbo');
let changed = true; // default: when unsure, run detect

const parseTurboJson = output => {
const start = output.indexOf('{');
if (start === -1) {
throw new Error('turbo dry run did not produce JSON');
}
return JSON.parse(output.slice(start));
};

const runTurboDry = cwd => {
const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
cwd,
encoding: 'utf8',
maxBuffer: 100 * 1024 * 1024,
});
return parseTurboJson(output);
};

const apiTaskHashes = summary => {
const entries = (summary.tasks || [])
.filter(t => {
const taskId = t.taskId || '';
return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
})
.map(t => [t.taskId, t.hash]);

if (entries.length === 0) {
throw new Error('turbo dry run contained no API task hashes');
}

return new Map(entries);
};

try {
const changedFiles = cp
.execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
cwd: workspace,
encoding: 'utf8',
})
.trim()
.split(/\n/)
.filter(Boolean);

const forcedFiles = changedFiles.filter(
f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
);

if (forcedFiles.length > 0) {
console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
} else {
const head = apiTaskHashes(runTurboDry(workspace));
const base = apiTaskHashes(runTurboDry(baseWorktree));
const allTaskIds = new Set([...head.keys(), ...base.keys()]);

changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
}
} catch (e) {
console.log('gate: falling back to changed=true:', e.message);
changed = true;
}

fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
console.log('tracked API task hash changed / unknown:', changed);
EOF

- name: Build current declarations
if: steps.gate.outputs.changed == 'true'
run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

- name: Resolve break-check cache key
id: break-check-key
if: steps.gate.outputs.changed == 'true'
run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

- name: Restore baseline from cache
id: baseline-cache
if: steps.gate.outputs.changed == 'true'
uses: actions/cache/restore@v4
with:
path: .api-snapshots-baseline
# 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: Install baseline dependencies
if: steps.baseline-cache.outputs.cache-matched-key == ''
if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
working-directory: .worktrees/break-check-baseline
run: pnpm install --frozen-lockfile

- name: Build baseline declarations
if: steps.baseline-cache.outputs.cache-matched-key == ''
if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
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
Expand All@@ -210,13 +295,14 @@ jobs:
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 == ''
if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
working-directory: .worktrees/break-check-baseline
run: |
pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
--output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

- name: Detect API changes
if: steps.gate.outputs.changed == 'true'
env:
BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
run: |
Expand All@@ -226,6 +312,10 @@ jobs:
--ai-apply-downgrades \
--fail-on-breaking

# Note: on the hash-equal skip path we intentionally post nothing. The "no API
# changes" comment below is only ever posted when detect actually ran and found
# nothing.

- name: Upload API changes report
uses: actions/upload-artifact@v4
if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
env:
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
with:
script: |
const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
}
}

// Stamp the head SHA detect actually ran on. Because pushes whose tracked
// declarations match the base are skipped silently (no comment update), this
// lets a reviewer see whether this comment reflects the current head or an
// earlier push.
const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
if (ranSha) {
body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
}

const comments = await github.paginate(github.rest.issues.listComments, {
owner: context.repo.owner,
repo: context.repo.repo,
Expand Down
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): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into

from

Jun 3, 2026
 Merged


ci(repo): gate api-changes detect on turbo cache-hit signal
#8723
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab067b9

ci(repo): gate api-changes detect on turbo cache-hit signal


jacekradko Jun 2, 2026
dcdbd30

Merge branch 'main' into jacek/gate-api-changes-turbo-cache


jacekradko Jun 2, 2026
0313d87

ci(repo): compare api gate hashes to base


jacekradko Jun 2, 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


2 changes: 2 additions & 0 deletions
.changeset/gate-api-changes-turbo-cache.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

144 changes: 122 additions & 22 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
 # 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 $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

 - name: Create baseline worktree
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 # Gate the expensive snapshot/detect work on turbo's content hashing, but compare
 # the PR head against the pinned base SHA. A cache HIT only means an output already
 # exists for the task hash; it does not prove the PR matches its base.
 - name: Determine API surface changed
 id: gate
 env:
 BASE_SHA: ${{ github.event.pull_request.base.sha }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 run: |
 node <<'EOF'
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');

 const workspace = process.env.GITHUB_WORKSPACE;
 const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
 const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
 const turbo = path.join(workspace, 'node_modules/.bin/turbo');
 let changed = true; // default: when unsure, run detect

 const parseTurboJson = output => {
 const start = output.indexOf('{');
 if (start === -1) {
 throw new Error('turbo dry run did not produce JSON');
 }
 return JSON.parse(output.slice(start));
 };

 const runTurboDry = cwd => {
 const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
 cwd,
 encoding: 'utf8',
 maxBuffer: 100 * 1024 * 1024,
 });
 return parseTurboJson(output);
 };

 const apiTaskHashes = summary => {
 const entries = (summary.tasks || [])
 .filter(t => {
 const taskId = t.taskId || '';
 return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
 })
 .map(t => [t.taskId, t.hash]);

 if (entries.length === 0) {
 throw new Error('turbo dry run contained no API task hashes');
 }

 return new Map(entries);
 };

 try {
 const changedFiles = cp
 .execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
 cwd: workspace,
 encoding: 'utf8',
 })
 .trim()
 .split(/\n/)
 .filter(Boolean);

 const forcedFiles = changedFiles.filter(
 f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
 );

 if (forcedFiles.length > 0) {
 console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
 } else {
 const head = apiTaskHashes(runTurboDry(workspace));
 const base = apiTaskHashes(runTurboDry(baseWorktree));
 const allTaskIds = new Set([...head.keys(), ...base.keys()]);

 changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
 }
 } catch (e) {
 console.log('gate: falling back to changed=true:', e.message);
 changed = true;
 }

 fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
 console.log('tracked API task hash changed / unknown:', changed);
 EOF

 - name: Build current declarations
 if: steps.gate.outputs.changed == 'true'
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Resolve break-check cache key
 id: break-check-key
 if: steps.gate.outputs.changed == 'true'
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 if: steps.gate.outputs.changed == 'true'
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 # 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: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 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
Expand All@@ -210,13 +295,14 @@ jobs:
 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 == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 if: steps.gate.outputs.changed == 'true'
 env:
 BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
Expand All@@ -226,6 +312,10 @@ jobs:
 --ai-apply-downgrades \
 --fail-on-breaking

 # Note: on the hash-equal skip path we intentionally post nothing. The "no API
 # changes" comment below is only ever posted when detect actually ran and found
 # nothing.

 - name: Upload API changes report
 uses: actions/upload-artifact@v4
 if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 with:
 script: |
 const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
 }
 }

 // Stamp the head SHA detect actually ran on. Because pushes whose tracked
 // declarations match the base are skipped silently (no comment update), this
 // lets a reviewer see whether this comment reflects the current head or an
 // earlier push.
 const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
 if (ranSha) {
 body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
Expand Down
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): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into

from

Jun 3, 2026
 Merged


ci(repo): gate api-changes detect on turbo cache-hit signal
#8723
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab067b9

ci(repo): gate api-changes detect on turbo cache-hit signal


jacekradko Jun 2, 2026
dcdbd30

Merge branch 'main' into jacek/gate-api-changes-turbo-cache


jacekradko Jun 2, 2026
0313d87

ci(repo): compare api gate hashes to base


jacekradko Jun 2, 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


2 changes: 2 additions & 0 deletions
.changeset/gate-api-changes-turbo-cache.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

144 changes: 122 additions & 22 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
 # 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 $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

 - name: Create baseline worktree
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 # Gate the expensive snapshot/detect work on turbo's content hashing, but compare
 # the PR head against the pinned base SHA. A cache HIT only means an output already
 # exists for the task hash; it does not prove the PR matches its base.
 - name: Determine API surface changed
 id: gate
 env:
 BASE_SHA: ${{ github.event.pull_request.base.sha }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 run: |
 node <<'EOF'
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');

 const workspace = process.env.GITHUB_WORKSPACE;
 const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
 const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
 const turbo = path.join(workspace, 'node_modules/.bin/turbo');
 let changed = true; // default: when unsure, run detect

 const parseTurboJson = output => {
 const start = output.indexOf('{');
 if (start === -1) {
 throw new Error('turbo dry run did not produce JSON');
 }
 return JSON.parse(output.slice(start));
 };

 const runTurboDry = cwd => {
 const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
 cwd,
 encoding: 'utf8',
 maxBuffer: 100 * 1024 * 1024,
 });
 return parseTurboJson(output);
 };

 const apiTaskHashes = summary => {
 const entries = (summary.tasks || [])
 .filter(t => {
 const taskId = t.taskId || '';
 return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
 })
 .map(t => [t.taskId, t.hash]);

 if (entries.length === 0) {
 throw new Error('turbo dry run contained no API task hashes');
 }

 return new Map(entries);
 };

 try {
 const changedFiles = cp
 .execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
 cwd: workspace,
 encoding: 'utf8',
 })
 .trim()
 .split(/\n/)
 .filter(Boolean);

 const forcedFiles = changedFiles.filter(
 f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
 );

 if (forcedFiles.length > 0) {
 console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
 } else {
 const head = apiTaskHashes(runTurboDry(workspace));
 const base = apiTaskHashes(runTurboDry(baseWorktree));
 const allTaskIds = new Set([...head.keys(), ...base.keys()]);

 changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
 }
 } catch (e) {
 console.log('gate: falling back to changed=true:', e.message);
 changed = true;
 }

 fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
 console.log('tracked API task hash changed / unknown:', changed);
 EOF

 - name: Build current declarations
 if: steps.gate.outputs.changed == 'true'
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Resolve break-check cache key
 id: break-check-key
 if: steps.gate.outputs.changed == 'true'
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 if: steps.gate.outputs.changed == 'true'
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 # 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: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 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
Expand All@@ -210,13 +295,14 @@ jobs:
 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 == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 if: steps.gate.outputs.changed == 'true'
 env:
 BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
Expand All@@ -226,6 +312,10 @@ jobs:
 --ai-apply-downgrades \
 --fail-on-breaking

 # Note: on the hash-equal skip path we intentionally post nothing. The "no API
 # changes" comment below is only ever posted when detect actually ran and found
 # nothing.

 - name: Upload API changes report
 uses: actions/upload-artifact@v4
 if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 with:
 script: |
 const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
 }
 }

 // Stamp the head SHA detect actually ran on. Because pushes whose tracked
 // declarations match the base are skipped silently (no comment update), this
 // lets a reviewer see whether this comment reflects the current head or an
 // earlier push.
 const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
 if (ranSha) {
 body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
Expand Down
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): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into

from

Jun 3, 2026
 Merged


ci(repo): gate api-changes detect on turbo cache-hit signal
#8723
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab067b9

ci(repo): gate api-changes detect on turbo cache-hit signal


jacekradko Jun 2, 2026
dcdbd30

Merge branch 'main' into jacek/gate-api-changes-turbo-cache


jacekradko Jun 2, 2026
0313d87

ci(repo): compare api gate hashes to base


jacekradko Jun 2, 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


2 changes: 2 additions & 0 deletions
.changeset/gate-api-changes-turbo-cache.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

144 changes: 122 additions & 22 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
 # 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 $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

 - name: Create baseline worktree
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 # Gate the expensive snapshot/detect work on turbo's content hashing, but compare
 # the PR head against the pinned base SHA. A cache HIT only means an output already
 # exists for the task hash; it does not prove the PR matches its base.
 - name: Determine API surface changed
 id: gate
 env:
 BASE_SHA: ${{ github.event.pull_request.base.sha }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 run: |
 node <<'EOF'
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');

 const workspace = process.env.GITHUB_WORKSPACE;
 const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
 const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
 const turbo = path.join(workspace, 'node_modules/.bin/turbo');
 let changed = true; // default: when unsure, run detect

 const parseTurboJson = output => {
 const start = output.indexOf('{');
 if (start === -1) {
 throw new Error('turbo dry run did not produce JSON');
 }
 return JSON.parse(output.slice(start));
 };

 const runTurboDry = cwd => {
 const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
 cwd,
 encoding: 'utf8',
 maxBuffer: 100 * 1024 * 1024,
 });
 return parseTurboJson(output);
 };

 const apiTaskHashes = summary => {
 const entries = (summary.tasks || [])
 .filter(t => {
 const taskId = t.taskId || '';
 return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
 })
 .map(t => [t.taskId, t.hash]);

 if (entries.length === 0) {
 throw new Error('turbo dry run contained no API task hashes');
 }

 return new Map(entries);
 };

 try {
 const changedFiles = cp
 .execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
 cwd: workspace,
 encoding: 'utf8',
 })
 .trim()
 .split(/\n/)
 .filter(Boolean);

 const forcedFiles = changedFiles.filter(
 f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
 );

 if (forcedFiles.length > 0) {
 console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
 } else {
 const head = apiTaskHashes(runTurboDry(workspace));
 const base = apiTaskHashes(runTurboDry(baseWorktree));
 const allTaskIds = new Set([...head.keys(), ...base.keys()]);

 changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
 }
 } catch (e) {
 console.log('gate: falling back to changed=true:', e.message);
 changed = true;
 }

 fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
 console.log('tracked API task hash changed / unknown:', changed);
 EOF

 - name: Build current declarations
 if: steps.gate.outputs.changed == 'true'
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Resolve break-check cache key
 id: break-check-key
 if: steps.gate.outputs.changed == 'true'
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 if: steps.gate.outputs.changed == 'true'
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 # 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: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 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
Expand All@@ -210,13 +295,14 @@ jobs:
 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 == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 if: steps.gate.outputs.changed == 'true'
 env:
 BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
Expand All@@ -226,6 +312,10 @@ jobs:
 --ai-apply-downgrades \
 --fail-on-breaking

 # Note: on the hash-equal skip path we intentionally post nothing. The "no API
 # changes" comment below is only ever posted when detect actually ran and found
 # nothing.

 - name: Upload API changes report
 uses: actions/upload-artifact@v4
 if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 with:
 script: |
 const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
 }
 }

 // Stamp the head SHA detect actually ran on. Because pushes whose tracked
 // declarations match the base are skipped silently (no comment update), this
 // lets a reviewer see whether this comment reflects the current head or an
 // earlier push.
 const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
 if (ranSha) {
 body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
Expand Down
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): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into

from

Jun 3, 2026
 Merged


ci(repo): gate api-changes detect on turbo cache-hit signal
#8723
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab067b9

ci(repo): gate api-changes detect on turbo cache-hit signal


jacekradko Jun 2, 2026
dcdbd30

Merge branch 'main' into jacek/gate-api-changes-turbo-cache


jacekradko Jun 2, 2026
0313d87

ci(repo): compare api gate hashes to base


jacekradko Jun 2, 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


2 changes: 2 additions & 0 deletions
.changeset/gate-api-changes-turbo-cache.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

144 changes: 122 additions & 22 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
 # 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 $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

 - name: Create baseline worktree
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 # Gate the expensive snapshot/detect work on turbo's content hashing, but compare
 # the PR head against the pinned base SHA. A cache HIT only means an output already
 # exists for the task hash; it does not prove the PR matches its base.
 - name: Determine API surface changed
 id: gate
 env:
 BASE_SHA: ${{ github.event.pull_request.base.sha }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 run: |
 node <<'EOF'
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');

 const workspace = process.env.GITHUB_WORKSPACE;
 const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
 const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
 const turbo = path.join(workspace, 'node_modules/.bin/turbo');
 let changed = true; // default: when unsure, run detect

 const parseTurboJson = output => {
 const start = output.indexOf('{');
 if (start === -1) {
 throw new Error('turbo dry run did not produce JSON');
 }
 return JSON.parse(output.slice(start));
 };

 const runTurboDry = cwd => {
 const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
 cwd,
 encoding: 'utf8',
 maxBuffer: 100 * 1024 * 1024,
 });
 return parseTurboJson(output);
 };

 const apiTaskHashes = summary => {
 const entries = (summary.tasks || [])
 .filter(t => {
 const taskId = t.taskId || '';
 return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
 })
 .map(t => [t.taskId, t.hash]);

 if (entries.length === 0) {
 throw new Error('turbo dry run contained no API task hashes');
 }

 return new Map(entries);
 };

 try {
 const changedFiles = cp
 .execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
 cwd: workspace,
 encoding: 'utf8',
 })
 .trim()
 .split(/\n/)
 .filter(Boolean);

 const forcedFiles = changedFiles.filter(
 f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
 );

 if (forcedFiles.length > 0) {
 console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
 } else {
 const head = apiTaskHashes(runTurboDry(workspace));
 const base = apiTaskHashes(runTurboDry(baseWorktree));
 const allTaskIds = new Set([...head.keys(), ...base.keys()]);

 changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
 }
 } catch (e) {
 console.log('gate: falling back to changed=true:', e.message);
 changed = true;
 }

 fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
 console.log('tracked API task hash changed / unknown:', changed);
 EOF

 - name: Build current declarations
 if: steps.gate.outputs.changed == 'true'
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Resolve break-check cache key
 id: break-check-key
 if: steps.gate.outputs.changed == 'true'
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 if: steps.gate.outputs.changed == 'true'
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 # 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: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 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
Expand All@@ -210,13 +295,14 @@ jobs:
 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 == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 if: steps.gate.outputs.changed == 'true'
 env:
 BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
Expand All@@ -226,6 +312,10 @@ jobs:
 --ai-apply-downgrades \
 --fail-on-breaking

 # Note: on the hash-equal skip path we intentionally post nothing. The "no API
 # changes" comment below is only ever posted when detect actually ran and found
 # nothing.

 - name: Upload API changes report
 uses: actions/upload-artifact@v4
 if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 with:
 script: |
 const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
 }
 }

 // Stamp the head SHA detect actually ran on. Because pushes whose tracked
 // declarations match the base are skipped silently (no comment update), this
 // lets a reviewer see whether this comment reflects the current head or an
 // earlier push.
 const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
 if (ranSha) {
 body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
Expand Down
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): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into

from

Jun 3, 2026
 Merged


ci(repo): gate api-changes detect on turbo cache-hit signal
#8723
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab067b9

ci(repo): gate api-changes detect on turbo cache-hit signal


jacekradko Jun 2, 2026
dcdbd30

Merge branch 'main' into jacek/gate-api-changes-turbo-cache


jacekradko Jun 2, 2026
0313d87

ci(repo): compare api gate hashes to base


jacekradko Jun 2, 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


2 changes: 2 additions & 0 deletions
.changeset/gate-api-changes-turbo-cache.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

144 changes: 122 additions & 22 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
 # 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 $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

 - name: Create baseline worktree
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 # Gate the expensive snapshot/detect work on turbo's content hashing, but compare
 # the PR head against the pinned base SHA. A cache HIT only means an output already
 # exists for the task hash; it does not prove the PR matches its base.
 - name: Determine API surface changed
 id: gate
 env:
 BASE_SHA: ${{ github.event.pull_request.base.sha }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 run: |
 node <<'EOF'
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');

 const workspace = process.env.GITHUB_WORKSPACE;
 const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
 const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
 const turbo = path.join(workspace, 'node_modules/.bin/turbo');
 let changed = true; // default: when unsure, run detect

 const parseTurboJson = output => {
 const start = output.indexOf('{');
 if (start === -1) {
 throw new Error('turbo dry run did not produce JSON');
 }
 return JSON.parse(output.slice(start));
 };

 const runTurboDry = cwd => {
 const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
 cwd,
 encoding: 'utf8',
 maxBuffer: 100 * 1024 * 1024,
 });
 return parseTurboJson(output);
 };

 const apiTaskHashes = summary => {
 const entries = (summary.tasks || [])
 .filter(t => {
 const taskId = t.taskId || '';
 return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
 })
 .map(t => [t.taskId, t.hash]);

 if (entries.length === 0) {
 throw new Error('turbo dry run contained no API task hashes');
 }

 return new Map(entries);
 };

 try {
 const changedFiles = cp
 .execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
 cwd: workspace,
 encoding: 'utf8',
 })
 .trim()
 .split(/\n/)
 .filter(Boolean);

 const forcedFiles = changedFiles.filter(
 f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
 );

 if (forcedFiles.length > 0) {
 console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
 } else {
 const head = apiTaskHashes(runTurboDry(workspace));
 const base = apiTaskHashes(runTurboDry(baseWorktree));
 const allTaskIds = new Set([...head.keys(), ...base.keys()]);

 changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
 }
 } catch (e) {
 console.log('gate: falling back to changed=true:', e.message);
 changed = true;
 }

 fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
 console.log('tracked API task hash changed / unknown:', changed);
 EOF

 - name: Build current declarations
 if: steps.gate.outputs.changed == 'true'
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Resolve break-check cache key
 id: break-check-key
 if: steps.gate.outputs.changed == 'true'
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 if: steps.gate.outputs.changed == 'true'
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 # 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: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 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
Expand All@@ -210,13 +295,14 @@ jobs:
 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 == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 if: steps.gate.outputs.changed == 'true'
 env:
 BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
Expand All@@ -226,6 +312,10 @@ jobs:
 --ai-apply-downgrades \
 --fail-on-breaking

 # Note: on the hash-equal skip path we intentionally post nothing. The "no API
 # changes" comment below is only ever posted when detect actually ran and found
 # nothing.

 - name: Upload API changes report
 uses: actions/upload-artifact@v4
 if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 with:
 script: |
 const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
 }
 }

 // Stamp the head SHA detect actually ran on. Because pushes whose tracked
 // declarations match the base are skipped silently (no comment update), this
 // lets a reviewer see whether this comment reflects the current head or an
 // earlier push.
 const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
 if (ranSha) {
 body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
Expand Down
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): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into

from

Jun 3, 2026
 Merged


ci(repo): gate api-changes detect on turbo cache-hit signal
#8723
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab067b9

ci(repo): gate api-changes detect on turbo cache-hit signal


jacekradko Jun 2, 2026
dcdbd30

Merge branch 'main' into jacek/gate-api-changes-turbo-cache


jacekradko Jun 2, 2026
0313d87

ci(repo): compare api gate hashes to base


jacekradko Jun 2, 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


2 changes: 2 additions & 0 deletions
.changeset/gate-api-changes-turbo-cache.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

144 changes: 122 additions & 22 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
 # 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 $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

 - name: Create baseline worktree
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 # Gate the expensive snapshot/detect work on turbo's content hashing, but compare
 # the PR head against the pinned base SHA. A cache HIT only means an output already
 # exists for the task hash; it does not prove the PR matches its base.
 - name: Determine API surface changed
 id: gate
 env:
 BASE_SHA: ${{ github.event.pull_request.base.sha }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 run: |
 node <<'EOF'
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');

 const workspace = process.env.GITHUB_WORKSPACE;
 const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
 const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
 const turbo = path.join(workspace, 'node_modules/.bin/turbo');
 let changed = true; // default: when unsure, run detect

 const parseTurboJson = output => {
 const start = output.indexOf('{');
 if (start === -1) {
 throw new Error('turbo dry run did not produce JSON');
 }
 return JSON.parse(output.slice(start));
 };

 const runTurboDry = cwd => {
 const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
 cwd,
 encoding: 'utf8',
 maxBuffer: 100 * 1024 * 1024,
 });
 return parseTurboJson(output);
 };

 const apiTaskHashes = summary => {
 const entries = (summary.tasks || [])
 .filter(t => {
 const taskId = t.taskId || '';
 return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
 })
 .map(t => [t.taskId, t.hash]);

 if (entries.length === 0) {
 throw new Error('turbo dry run contained no API task hashes');
 }

 return new Map(entries);
 };

 try {
 const changedFiles = cp
 .execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
 cwd: workspace,
 encoding: 'utf8',
 })
 .trim()
 .split(/\n/)
 .filter(Boolean);

 const forcedFiles = changedFiles.filter(
 f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
 );

 if (forcedFiles.length > 0) {
 console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
 } else {
 const head = apiTaskHashes(runTurboDry(workspace));
 const base = apiTaskHashes(runTurboDry(baseWorktree));
 const allTaskIds = new Set([...head.keys(), ...base.keys()]);

 changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
 }
 } catch (e) {
 console.log('gate: falling back to changed=true:', e.message);
 changed = true;
 }

 fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
 console.log('tracked API task hash changed / unknown:', changed);
 EOF

 - name: Build current declarations
 if: steps.gate.outputs.changed == 'true'
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Resolve break-check cache key
 id: break-check-key
 if: steps.gate.outputs.changed == 'true'
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 if: steps.gate.outputs.changed == 'true'
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 # 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: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 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
Expand All@@ -210,13 +295,14 @@ jobs:
 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 == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 if: steps.gate.outputs.changed == 'true'
 env:
 BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
Expand All@@ -226,6 +312,10 @@ jobs:
 --ai-apply-downgrades \
 --fail-on-breaking

 # Note: on the hash-equal skip path we intentionally post nothing. The "no API
 # changes" comment below is only ever posted when detect actually ran and found
 # nothing.

 - name: Upload API changes report
 uses: actions/upload-artifact@v4
 if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 with:
 script: |
 const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
 }
 }

 // Stamp the head SHA detect actually ran on. Because pushes whose tracked
 // declarations match the base are skipped silently (no comment update), this
 // lets a reviewer see whether this comment reflects the current head or an
 // earlier push.
 const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
 if (ranSha) {
 body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
Expand Down
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): gate api-changes detect on turbo cache-hit signal#8723

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 3 commits into

from

Jun 3, 2026
 Merged


ci(repo): gate api-changes detect on turbo cache-hit signal
#8723
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab067b9

ci(repo): gate api-changes detect on turbo cache-hit signal


jacekradko Jun 2, 2026
dcdbd30

Merge branch 'main' into jacek/gate-api-changes-turbo-cache


jacekradko Jun 2, 2026
0313d87

ci(repo): compare api gate hashes to base


jacekradko Jun 2, 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


2 changes: 2 additions & 0 deletions
.changeset/gate-api-changes-turbo-cache.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

144 changes: 122 additions & 22 deletions
.github/workflows/api-changes.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,29 +154,10 @@ 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
 # 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 $BREAK_CHECK_FILTERS

 - name: Fetch base commit
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1

 - name: Create baseline worktree
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 run: |
 mkdir -p .worktrees
 git worktree add --detach .worktrees/break-check-baseline "${{ github.event.pull_request.base.sha }}"
Expand All@@ -193,13 +174,117 @@ jobs:
 cp break-check.config.json .worktrees/break-check-baseline/break-check.config.json
 fi

 # Gate the expensive snapshot/detect work on turbo's content hashing, but compare
 # the PR head against the pinned base SHA. A cache HIT only means an output already
 # exists for the task hash; it does not prove the PR matches its base.
 - name: Determine API surface changed
 id: gate
 env:
 BASE_SHA: ${{ github.event.pull_request.base.sha }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 run: |
 node <<'EOF'
 const cp = require('child_process');
 const fs = require('fs');
 const path = require('path');

 const workspace = process.env.GITHUB_WORKSPACE;
 const baseWorktree = path.join(workspace, '.worktrees/break-check-baseline');
 const filters = process.env.BREAK_CHECK_FILTERS.trim().split(/\s+/);
 const turbo = path.join(workspace, 'node_modules/.bin/turbo');
 let changed = true; // default: when unsure, run detect

 const parseTurboJson = output => {
 const start = output.indexOf('{');
 if (start === -1) {
 throw new Error('turbo dry run did not produce JSON');
 }
 return JSON.parse(output.slice(start));
 };

 const runTurboDry = cwd => {
 const output = cp.execFileSync(turbo, ['build:declarations', '--dry=json', ...filters], {
 cwd,
 encoding: 'utf8',
 maxBuffer: 100 * 1024 * 1024,
 });
 return parseTurboJson(output);
 };

 const apiTaskHashes = summary => {
 const entries = (summary.tasks || [])
 .filter(t => {
 const taskId = t.taskId || '';
 return taskId.endsWith('#build') || taskId.endsWith('#build:declarations');
 })
 .map(t => [t.taskId, t.hash]);

 if (entries.length === 0) {
 throw new Error('turbo dry run contained no API task hashes');
 }

 return new Map(entries);
 };

 try {
 const changedFiles = cp
 .execFileSync('git', ['diff', '--name-only', process.env.BASE_SHA, process.env.HEAD_SHA], {
 cwd: workspace,
 encoding: 'utf8',
 })
 .trim()
 .split(/\n/)
 .filter(Boolean);

 const forcedFiles = changedFiles.filter(
 f => f === 'break-check.config.json' || f === '.github/workflows/api-changes.yml',
 );

 if (forcedFiles.length > 0) {
 console.log('gate: workflow/config changed; running detect:', forcedFiles.join(', '));
 } else {
 const head = apiTaskHashes(runTurboDry(workspace));
 const base = apiTaskHashes(runTurboDry(baseWorktree));
 const allTaskIds = new Set([...head.keys(), ...base.keys()]);

 changed = [...allTaskIds].some(taskId => head.get(taskId) !== base.get(taskId));
 }
 } catch (e) {
 console.log('gate: falling back to changed=true:', e.message);
 changed = true;
 }

 fs.appendFileSync(process.env.GITHUB_OUTPUT,`changed=${changed}\n`);
 console.log('tracked API task hash changed / unknown:', changed);
 EOF

 - name: Build current declarations
 if: steps.gate.outputs.changed == 'true'
 run: pnpm turbo build:declarations $TURBO_ARGS $BREAK_CHECK_FILTERS

 - name: Resolve break-check cache key
 id: break-check-key
 if: steps.gate.outputs.changed == 'true'
 run: echo "ref=${BREAK_CHECK_PACKAGE##*@}" >> "$GITHUB_OUTPUT"

 - name: Restore baseline from cache
 id: baseline-cache
 if: steps.gate.outputs.changed == 'true'
 uses: actions/cache/restore@v4
 with:
 path: .api-snapshots-baseline
 # 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: Install baseline dependencies
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: pnpm install --frozen-lockfile

 - name: Build baseline declarations
 if: steps.baseline-cache.outputs.cache-matched-key == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 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
Expand All@@ -210,13 +295,14 @@ jobs:
 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 == ''
 if: steps.gate.outputs.changed == 'true' && steps.baseline-cache.outputs.cache-matched-key == ''
 working-directory: .worktrees/break-check-baseline
 run: |
 pnpm dlx --package "$BREAK_CHECK_PACKAGE" break-check snapshot \
 --output "$GITHUB_WORKSPACE/.api-snapshots-baseline"

 - name: Detect API changes
 if: steps.gate.outputs.changed == 'true'
 env:
 BREAK_CHECK_ANTHROPIC_API_KEY: ${{ secrets.BREAK_CHECK_ANTHROPIC_API_KEY }}
 run: |
Expand All@@ -226,6 +312,10 @@ jobs:
 --ai-apply-downgrades \
 --fail-on-breaking

 # Note: on the hash-equal skip path we intentionally post nothing. The "no API
 # changes" comment below is only ever posted when detect actually ran and found
 # nothing.

 - name: Upload API changes report
 uses: actions/upload-artifact@v4
 if: always()
Expand All@@ -240,6 +330,7 @@ jobs:
 uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
 env:
 RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 HEAD_SHA: ${{ github.event.pull_request.head.sha }}
 with:
 script: |
 const fs = require('fs');
Expand DownExpand Up@@ -274,6 +365,15 @@ jobs:
 }
 }

 // Stamp the head SHA detect actually ran on. Because pushes whose tracked
 // declarations match the base are skipped silently (no comment update), this
 // lets a reviewer see whether this comment reflects the current head or an
 // earlier push.
 const ranSha = (process.env.HEAD_SHA || '').slice(0, 7);
 if (ranSha) {
 body += `\n\n<sub>Last ran on \`${ranSha}\`. Pushes that change no tracked declarations (no API surface change vs. base) are skipped and don't update this comment.</sub>`;
 }

 const comments = await github.paginate(github.rest.issues.listComments, {
 owner: context.repo.owner,
 repo: context.repo.repo,
Expand Down
Loading