Skip to content

docs: archive v4.5.0 API reference - #247

Merged
andrewzolotukhin merged 2 commits into
developmentfrom
docs/archive-v4-5-0-api
Oct 9, 2026
Merged

andrewzolotukhin merged 2 commits into
developmentfrom
docs/archive-v4-5-0-api

Conversation

@andrewzolotukhin

@andrewzolotukhin andrewzolotukhin commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

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:

npm ci
npm run build
npm run docs
VERSION=4.5.0 npm run docs:snapshot

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 build and npm run test passed: 293 test files, 5,303 tests, no type errors.
  • npm run build:docs-site passed. HTTP smoke checks returned 200 for the version picker, versions.json, archive index, schema module, stylesheet, search data and bundled license.
  • All 62,432 local references across 791 HTML pages resolve. All 1,888 unique source links point to the release commit and existing source locations.
  • All 8,330 files in the 13 older archives retain their original SHA-256 hashes.
  • Regenerating development's latest reference preserved all 804 v4.5.0 archive file hashes; development-only APIs remain outside the release snapshot.

Update the locked development tools from concurrently 9.2.4 to 9.2.5 and shell-quote 1.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, fresh npm run build, npm run test (293 files / 5,303 tests, no type errors) and npm audit --audit-level=high all 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.

@andrewzolotukhin
andrewzolotukhin marked this pull request as ready for review October 9, 2026 11:17
@andrewzolotukhin
andrewzolotukhin merged commit 3e58cdc into development Oct 9, 2026
4 checks passed
@andrewzolotukhin
andrewzolotukhin deleted the docs/archive-v4-5-0-api branch October 9, 2026 11:42
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