ci: upgrade yarn for Node 24 TypeDoc build#3728
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe PR updates the GitHub Actions workflow for documentation builds to use Node.js v22 instead of v24 when running the ChangesDocumentation Build Workflow Configuration
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/workflows/book.yml (1)
149-149: 💤 Low valueConsider documenting the version pin.
Adding an inline comment explaining why v22 is pinned would help future maintainers understand this isn't an oversight.
📝 Suggested documentation
- name: Setup Node.js uses: actions/setup-node@v4 with: + # Pinned to v22 due to EBADF errors in TypeDoc with Yarn PnP under Node 24+ node-version: "22"🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/book.yml at line 149, Add an inline comment next to the node-version: "22" pin explaining why Node 22 is required (e.g., compatibility with runtime, specific package or CI tools, or security/maintenance policy). Update the workflow snippet containing node-version: "22" so the comment states the reason and any link to issue/PR or upgrade plan, making future maintainers aware this pin is intentional and how to change it.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/workflows/book.yml:
- Line 149: Add an inline comment next to the node-version: "22" pin explaining
why Node 22 is required (e.g., compatibility with runtime, specific package or
CI tools, or security/maintenance policy). Update the workflow snippet
containing node-version: "22" so the comment states the reason and any link to
issue/PR or upgrade plan, making future maintainers aware this pin is
intentional and how to change it.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c338253b-745c-471e-a083-f9e7fb031269
📒 Files selected for processing (1)
.github/workflows/book.yml
d4a3b46 to
260174c
Compare
1844399 to
2e58665
Compare
2e58665 to
3dd26f4
Compare
ci: upgrade yarn for Node 24 TypeDoc build
Issue being fixed or feature implemented
The GitHub Pages book deployment is failing in the
Build JS/TS API docsjobwhen
yarn typedocruns under Node.js 24.15.0 with Yarn PnP enabled.Failing job:
https://github.com/dashpay/platform/actions/runs/26277810277/job/77346306870
The crash is:
What was done?
Upgraded the repo-managed Yarn Berry release from 4.12.0 to 4.14.1 and kept
the Pages book workflow on Node.js 24.
Updated files:
package.jsonpackageManager.yarnrc.ymlyarnPath.yarn/releases/yarn-4.14.1.cjs.pnp.cjs,.pnp.loader.mjs,yarn.lock.github/workflows/book.ymlpath filters for Yarn/PnP files, so Yarn-onlychanges also trigger the Pages deploy workflow
This keeps the fix in the dependency manager layer instead of pinning the
workflow back to Node.js 22.
Validation
Parsed
.github/workflows/book.ymlas YAML successfully.Smoke-tested the upgraded Yarn setup with:
Node 24.15.0 A/B result:
A. Base branch state, Yarn 4.12.0, reproduced the failure from a clean
origin/v3.1-devsnapshot:Result: install completed, then TypeDoc failed with
EBADF: bad file descriptor, fstatunder Node.js 24.15.0.B. Updated branch state, Yarn 4.14.1, passed with the workflow-equivalent
commands:
Result: TypeDoc generated HTML successfully with 0 errors and 3 pre-existing
warnings.
Ran pre-PR code review gate; fixed the path-filter finding by adding Yarn/PnP
files to
.github/workflows/book.ymltriggers.Breaking Changes
None.
Checklist
corresponding section if my code contains any
For repository code-owners and collaborators only