Skip to content

fix(site): the read API page fits its weight budget again, and CI checks the budget before merge - #35

Merged
jackulau merged 2 commits into
mainfrom
fix/site-api-read-budget
Nov 12, 2026
Merged

jackulau merged 2 commits into
mainfrom
fix/site-api-read-budget

Conversation

@jackulau

Copy link
Copy Markdown
Owner

The site has not deployed since #32 merged. The Site workflow stops at its Perf budget step: /docs/api/read/ is 30.3KB brotli against a 30.0KB budget. The page is the part of the generated API reference that gained the weight edit and checkpoint fields.

What changes

  • Budget. /docs/api/read/ goes from 30KB to 33KB in apps/site/scripts/perf-budget.mjs, about 10% over what the page measures, the same rule the other generated reference pages follow.
  • CI. The budget ran only in the Site workflow on main, so feat: weight edits read the same on every surface, and experiments record their checkpoint #32 passed every check and then stopped the deploy. CI now runs npm run perf:budget after the site build on the Linux Node 24 leg, the same OS and Node as the Site workflow. The step took 22 seconds in the Site workflow.
  • Docs. docs/perf.md says where the budget runs.

Two commits, one per change.

Checks

  • The old script on a build of main's content: FAIL /docs/api/read/: HTML is 30.3KB brotli, budget 30.0KB. The new script on the same build: perf-budget: ok, closest page /docs/agents/ at 25.1KB of 26.0KB.
  • actionlint -shellcheck= .github/workflows/*.yml: clean. npm run lint: clean. Docs tests: 51 of 51.

Not checked locally

…e deploys

/docs/api/read is 30.3KB brotli with the weight edit and checkpoint fields
from #32, over its 30KB budget, which stopped the Site workflow before the
deploy. The page is part of the generated API reference and grows with the
tool, so its budget goes to 33KB, about 10% over what it measures.
…the deploy

The budget ran only in the Site workflow on main, so #32 passed CI and then
stopped the deploy. CI now runs it after the site build, on the Linux Node 24
leg, the same OS and Node as the Site workflow.
@jackulau
jackulau merged commit 154558e into main Nov 12, 2026
29 checks passed
@jackulau
jackulau deleted the fix/site-api-read-budget branch November 12, 2026 23:47
@jackulau

Copy link
Copy Markdown
Owner Author

Correction to the description: "the site has not deployed since #32" overstates it. The Site workflow failed at Perf budget on the #32, #33 and #34 merge commits, and it is green again on this merge (154558e6). Its Deploy step is skipped on every run, before #32 as well, because the CLOUDFLARE_API_TOKEN secret is not set, so https://coding.sh still serves the last deploy made by hand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant