Repository navigation
docs: archive v4.5.0 API reference - #247
Merged
Merged
Conversation
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.
Preserve the released v4.5.0 API reference at
/api-docs/v4.5.0/before v5 regenerates the current documentation. Add v4.5.0 to the version picker and retain all 13 previous snapshots.Generated from master at
6aaaf221ff3bab830dc6dd6411787ddde9f899ca, where all 19 published packages are version 4.5.0. This PR is based on development and adds the archive, its version-picker entries, and a small build-tool lockfile fix to clear the dependency-security CI gate.Generation used Node 24.15.0, npm 11.12.1, TypeScript 6.0.3 and TypeDoc 0.28.19 from master's lockfile:
Bundle the release's license and adjust ten generated package-page license links to the bundled file; the root reference also resolves within the archive. TypeDoc completed with zero errors and 238 existing comment/documentation warnings.
Validation on the development-based branch:
npm run lint,npm run buildandnpm run testpassed: 293 test files, 5,303 tests, no type errors.npm run build:docs-sitepassed. HTTP smoke checks returned 200 for the version picker, versions.json, archive index, schema module, stylesheet, search data and bundled license.latestreference preserved all 804 v4.5.0 archive file hashes; development-only APIs remain outside the release snapshot.Update the locked development tools from
concurrently9.2.4 to 9.2.5 andshell-quote1.9.0 to 1.12.0 to fix the critical shell-quote advisory that blocked the original CI run. npm regenerated only these two lockfile entries; package manifests and the generation toolchain are unchanged. No published-package behavior changes, so no changeset is required.After the fix, a clean
npm ci,npm run lint, freshnpm run build,npm run test(293 files / 5,303 tests, no type errors) andnpm audit --audit-level=highall passed. The audit reports zero high or critical findings. SHA-256 checks confirm all 9,134 files across every archived documentation version are unchanged.GitHub Actions run 37921848758 passed for commit
a5d39f8e60126f60edcec4e6c3130701e225376d. All four jobs succeeded: main validation, PostgreSQL query integration, S3 storage integration and demo API/browser/telemetry E2E. The main job passed every step, including the dependency audit, packed-package smoke tests, both documentation website builds and API reference generation for every package.