chore(docs): regenerate the API reference to unblock ci (lint) - #3419
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Warning Review limit reached
Next review available in: 17 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (41)
Comment |
Correction: this does not fix CI. Do not merge on my say-so.My original verification claim above ("After: exits 0, 0 outdated") is true locally only. CI still reports the same 41 modules outdated with this exact commit, What I have since established:
So the generator output is environment-dependent in some way I have not isolated, and the gate cannot currently be satisfied from a developer machine: regenerate locally, commit, and CI still calls it outdated. That makes this a broken gate rather than stale content, and it is why every open PR shows a red I also retract the reasoning in the description above. I argued the symmetric 4915/4915 diff proved genuine staleness rather than a non-deterministic generator, because normalizing Suggested next probeHave the check print its diff in CI, or upload the freshly generated What to do with this PRClose it unless someone wants to land the regeneration anyway. It is a no-op for the documented surface, it conflicts with any other branch that regenerates the same files, and on the evidence above it will not turn |
There was a problem hiding this comment.
Pull request overview
Regenerates the generated docs/api-reference/veryfront/*.md API reference pages to resolve drift against the current output of deno task docs:api-reference:check, unblocking the ci (lint) job on unrelated pull requests.
Changes:
- Regenerated API reference markdown files under
docs/api-reference/veryfront/to match the current generator output. - Updated many GitHub source URLs (line anchors and resulting table padding) without changing the documented symbol set.
Reviewed changes
Copilot reviewed 33 out of 41 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/api-reference/veryfront/webhook.md | Updates generated source links/anchors for webhook API reference. |
| docs/api-reference/veryfront/trigger.md | Updates generated source links/anchors for trigger API reference. |
| docs/api-reference/veryfront/tool.md | Updates generated tables and source anchors for tool APIs. |
| docs/api-reference/veryfront/task.md | Updates generated source anchors for task APIs. |
| docs/api-reference/veryfront/skill.md | Updates generated source anchors for skill APIs. |
| docs/api-reference/veryfront/server.md | Updates generated source anchors for server APIs. |
| docs/api-reference/veryfront/security.md | Updates generated source anchors for security APIs. |
| docs/api-reference/veryfront/schemas.md | Updates generated source anchors for schemas APIs. |
| docs/api-reference/veryfront/schedule.md | Updates generated source anchors for schedule APIs. |
| docs/api-reference/veryfront/sandbox.md | Updates generated source anchors for sandbox APIs. |
| docs/api-reference/veryfront/runs.md | Updates generated source anchors for runs APIs. |
| docs/api-reference/veryfront/router.md | Updates generated source anchors for router APIs. |
| docs/api-reference/veryfront/resource.md | Updates generated source anchors for resource APIs. |
| docs/api-reference/veryfront/release-assets.md | Updates generated source anchors for release-assets APIs. |
| docs/api-reference/veryfront/prompt.md | Updates generated source anchors for prompt APIs. |
| docs/api-reference/veryfront/oauth.md | Updates generated source anchors for OAuth APIs. |
| docs/api-reference/veryfront/middleware.md | Updates generated source anchors for middleware APIs. |
| docs/api-reference/veryfront/metrics.md | Updates generated source anchors for metrics APIs. |
| docs/api-reference/veryfront/mdx.md | Updates generated source anchors for MDX APIs. |
| docs/api-reference/veryfront/mcp.md | Updates generated source anchors for MCP APIs. |
| docs/api-reference/veryfront/markdown.md | Updates generated source anchors for markdown APIs. |
| docs/api-reference/veryfront/knowledge.md | Updates generated source anchors for knowledge APIs. |
| docs/api-reference/veryfront/integrations.md | Updates generated source anchors for integrations APIs. |
| docs/api-reference/veryfront/index.md | Updates generated source anchors for root veryfront APIs. |
| docs/api-reference/veryfront/index.client.md | Updates generated source anchors for client veryfront APIs. |
| docs/api-reference/veryfront/head.md | Updates generated source anchors for head APIs. |
| docs/api-reference/veryfront/fs.md | Updates generated source anchors for fs APIs. |
| docs/api-reference/veryfront/fonts.md | Updates generated source anchors for fonts APIs. |
| docs/api-reference/veryfront/embedding.md | Updates generated source anchors for embedding APIs. |
| docs/api-reference/veryfront/context.md | Updates generated source anchors for context APIs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
`deno task docs:api-reference:check` fails on main, so the `ci (lint)` job is red on every open pull request regardless of what the branch changes. Reproduced on 59fe62c with 41 modules reported outdated, and on the earlier eae9c56 with the identical 41, so this has been red for a while. The drift is mechanical. Source links carry a line anchor, symbols moved, and the committed reference still points at the old lines: -.../src/react/runtime/core.ts#L410 +.../src/react/runtime/core.ts#L409 Most of the diff follows from that: the link text changes length, so the markdown table columns re-pad. One entry, `AGENT_CATALOG_KINDS`, gains a line anchor its committed link lacked. Nothing about the documented surface changes. The set of documented symbols is identical before and after at 4522 entries, none added and none removed, and the insertion and deletion counts match exactly at 4915 each. Running `deno task docs` and committing the result makes the check pass, which is what the check's own failure message asks for.
The previous regeneration was produced from a source tree that differed by one line, so every source link in all 41 files was off by one and the staleness check still failed.
c153003 to
5e60c2f
Compare
|
Following up on the correction above: the gate turned out to be satisfiable from a developer machine after all, and this PR is now green. Posting the evidence rather than just the result, since the earlier conclusion was reasonable on what was observable at the time. What was actually wrong. The committed pages had been generated against a source tree that differed from the branch by one line, so every Fix. Regenerated against the branch source and rebased onto main in Verified the way the correction asked. The passing On the non-determinism theory. It does not hold up. Regenerating on two unrelated branches (#3416 and #3397) changed exactly one file each, The part that is real, and is a live problem. Worth fixing at the source. The generator embeds absolute line numbers but pins the URL to |
Description
deno task docs:api-reference:checkfails onmain, so theci (lint)job is red on every open pull request regardless of what the branch changes.Reproduced on
59fe62c4c(current main) with 41 modules reported outdated, and on the oldereae9c56e6with the identical 41 set, so this has been red for a while. It is not caused by any one PR: I first hit it on #3416, measured the branch and a cleanorigin/maincheckout, and the outdated sets were byte-identical.The drift is mechanical
Source links carry a line anchor. Symbols moved, and the committed reference still points at the old lines:
Most of the diff follows from that one substitution: the link text changes length, so the markdown table columns re-pad. One entry,
AGENT_CATALOG_KINDS, gains a line anchor its committed link lacked.Nothing about the documented surface changes
I checked that rather than assuming it, because a symmetric diff across 41 generated files could equally have meant a non-deterministic generator, which regeneration would not fix. It isn't: normalizing
#L<n>collapses almost the entire diff, and the residue is table padding plus that one anchor.Related Issue(s)
None filed. Found while getting
ci (lint)green on #3416.Type of Change
Checklist
No tests: this is generated output, and
docs:api-reference:checkis the test.Verification
docs:api-reference:checkexits 1, 41 outdated.deno task docs, which is what the check's failure message instructs.Note
This is generated output, so it conflicts with any other branch that regenerates the same files. Worth merging promptly, or closing in favour of whoever gets there first. #3416 carries no docs change of its own: the reference lists top-level symbols rather than interface fields, so the option it adds to
StartProductionServerOptionsdoes not alter the generated output.