Repository navigation
docs(api): add the 4.2.0 API reference JSON and v4-2-0 tree - #4550
Merged
Merged
Conversation
release.yml builds the `wheels lookup` docs index with --strict against docs/api/v<version>.json, so the 4.2.0 release needs this file committed. It is the API JSON that the develop snapshot build generated on c3665d9 (/wheels/api?format=json&type=core), unchanged: 406 functions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Peter Amiri <peter@alurium.com>
node web/scripts/generate-api-docs.mjs 4.2.0, from docs/api/v4.2.0.json: 406 function pages across 10 sections (19 more than v4-1-0, none removed). The tree isn't listed as current until the 4.2.0 versions flip. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Peter Amiri <peter@alurium.com>
Collaborator
Author
|
Review: head 1e4fb64. APPROVE (ready to merge for the 4.2.0 cut).
|
3 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
release.ymlbuilds thewheels lookupdocs index withbuild-docs-index.mjs --strict --version $WHEELS_VERSION, which reads the committeddocs/api/v<version>.json. A 4.2.0 release fails withoutdocs/api/v4.2.0.json, as 4.1.0 neededv4.1.0.json. The step runs before anything publishes, so a missing file fails safely, but it still has to be here before the release merge.The file is the API JSON the develop snapshot build generated on c3665d9 (Wheels Snapshots run 38071933831, artifact
api-docs-snapshot, from/wheels/api?format=json&type=core), copied unchanged. It contains no version string. It has 406 functions, against 388 inv4.1.0.json.It also adds the generated
web/sites/api/src/content/docs/v4-2-0/tree (node web/scripts/generate-api-docs.mjs 4.2.0): 406 function pages across 10 sections, 19 more than v4-1-0 and none removed. API_VERSIONS doesn't list it yet; the versions flip (#4322) makes it current.Release-prep PR: it merges as part of the 4.2.0 cut. If framework code changes the public API before the tag, it needs regenerating.
Checks
jq -e '.functions and .sections'node web/scripts/generate-api-docs.mjs 4.2.0regenerates the tree with no diffnode tools/build/scripts/build-docs-index.mjs --strict --version 4.2.0(exactly whatrelease.ymlruns on main) passes: 406 API entries from v4.2.0.json, 1785 guide sections from v4-2-0🤖 Generated with Claude Code