fix(docs): surface SDK diffs in js-libs-update workflow PRs (#46742)

Two-part fix for the Update JS Client Libraries Docs workflow. First,
the `make` invocation was narrowed to `make download.tsdoc.v2` so the
workflow no longer re-downloads unrelated Management and Storage REST
openapi specs alongside the JS TypeDoc files, which was the source of
the noise in #46738. Second, the `build-reference-content` snapshot test
now serializes to a JSON file via `toMatchFileSnapshot` with a
cycle-breaker, because the previous `toMatchSnapshot` of a raw object
was being collapsed to `[Object]` placeholders by pretty-format (533 of
them), hiding every param rename, JSDoc edit, return-type change, and
signature tweak. Verified against supabase-js v2.108.0: the `count` to
`rows` rename in `PostgrestTransformBuilder.{limit,maxAffected}` now
shows up in the snapshot diff as expected.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Chores**
* Updated documentation generation workflow to run a more targeted build
command.
* Added ignore rule for test snapshot files and refreshed the
autogenerated PR description/reference snapshot.

* **Tests**
* Improved test snapshot strategy to use file-based snapshots and robust
handling of circular structures for more reliable assertions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Katerina Skroumpelou authored and GitHub committed 2026-06-08 20:05:28 +03:00
1 parent 35df570342
commit 4af431da00
5 files changed
+98085 -27319

No files matched your search

+2 -2
View File
@@ -50,7 +50,7 @@ jobs:
echo "Regenerating tsdoc files for JS client libraries..."
echo "Source: ${SOURCE}"
echo "Version: ${VERSION}"
make
make download.tsdoc.v2
- name: Refresh reference-content snapshot
working-directory: apps/docs
@@ -74,7 +74,7 @@ jobs:
title: 'docs: update js sdk docs (${{ github.event.inputs.version }})'
body: |
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.
Ran `make download.tsdoc.v2` in apps/docs/spec and refreshed the reference-content snapshot.
**Details:**
- **Version:** `${{ github.event.inputs.version }}`