Skip to content

docs(react): add JSDoc to hooks and schema factory functions #7092

docs(react): add JSDoc to hooks and schema factory functions

docs(react): add JSDoc to hooks and schema factory functions #7092

Triggered via pull request March 21, 2026 22:11
Status Success
Total duration 7m 35s
Artifacts 15

build.yml

on: pull_request
Matrix: playwright
Merge Playwright Reports
42s
Merge Playwright Reports
Fit to window
Zoom out
Zoom in

Annotations

2 errors, 9 warnings, and 7 notices
[chromium] › src/end-to-end/keyboardhandlers/keyboardhandlers.test.ts:77:7 › Check Keyboard Handlers' Behaviour › Check Enter preserves nested blocks for empty block: tests/src/utils/editor.ts#L47
1) [chromium] › src/end-to-end/keyboardhandlers/keyboardhandlers.test.ts:77:7 › Check Keyboard Handlers' Behaviour › Check Enter preserves nested blocks for empty block Error: expect(string).toMatchSnapshot(expected) @@ -23,91 +23,22 @@ ] }, { "type": "blockContainer", "attrs": { - "id": "4" + "id": "1" }, "content": [ { "type": "paragraph", "attrs": { "backgroundColor": "default", "textColor": "default", "textAlignment": "left" } - }, - { - "type": "blockGroup", - "content": [ - { - "type": "blockContainer", - "attrs": { - "id": "1" - }, - "content": [ - { - "type": "heading", - "attrs": { - "backgroundColor": "default", - "textColor": "default", - "textAlignment": "left", - "level": 2, - "isToggleable": false - }, - "content": [ - { - "type": "text", - "text": "Heading" - } - ] - } - ] - }, - { - "type": "blockContainer", - "attrs": { - "id": "2" - }, - "content": [ - { - "type": "heading", - "attrs": { - "backgroundColor": "default", - "textColor": "default", - "textAlignment": "left", - "level": 3, - "isToggleable": false - }, - "content": [ - { - "type": "text", - "text": "Heading" - } - ] - } - ] - } - ] } ] - }, - { - "type": "blockContainer", - "attrs": { - "id": "3" - }, - "content": [ - { - "type": "paragraph", - "attrs": { - "backgroundColor": "default", - "textColor": "default", - "textAlignment": "left" - } - } - ] } ] } ] } Expected: /__w/BlockNote/BlockNote/tests/src/end-to-end/keyboardhandlers/keyboardhandlers.test.ts-snapshots/enterPreservesNestedBlocksEmpty-json-chromium-linux.json Received: /__w/BlockNote/BlockNote/tests/test-results/keyboardhandlers-keyboardh-5461c-sted-blocks-for-empty-block-chromium/enterPreservesNestedBlocksEmpty-json-actual.json at ../utils/editor.ts:47 45 | // Remove id from docs 46 | const doc = JSON.stringify(await getDoc(page), null, 2); > 47 | expect(doc).toMatchSnapshot(`${name}.json`); | ^ 48 | } 49 | at compareDocToSnapshot (/__w/BlockNote/BlockNote/tests/src/utils/editor.ts:47:15) a
[webkit] › src/end-to-end/customblocks/customblocks.test.ts:10:7 › Check custom block functionality › Should be able to interactively update vanilla custom blocks: tests/src/end-to-end/customblocks/customblocks.test.ts#L19
1) [webkit] › src/end-to-end/customblocks/customblocks.test.ts:10:7 › Check custom block functionality › Should be able to interactively update vanilla custom blocks Error: expect(Buffer).toMatchSnapshot(expected) 33106 pixels (ratio 0.01 of all image pixels) are different. Expected: /__w/BlockNote/BlockNote/tests/src/end-to-end/customblocks/customblocks.test.ts-snapshots/vanilla-interactivity-webkit-linux.png Received: /__w/BlockNote/BlockNote/tests/test-results/customblocks-customblocks--8679c-pdate-vanilla-custom-blocks-webkit/vanilla-interactivity-actual.png Diff: /__w/BlockNote/BlockNote/tests/test-results/customblocks-customblocks--8679c-pdate-vanilla-custom-blocks-webkit/vanilla-interactivity-diff.png 17 | 18 | await compareDocToSnapshot(page, "vanillaInteractivity"); > 19 | expect(await page.screenshot()).toMatchSnapshot( | ^ 20 | "vanilla-interactivity.png", 21 | ); 22 | }); at /__w/BlockNote/BlockNote/tests/src/end-to-end/customblocks/customblocks.test.ts:19:37
Playwright Build
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/cache@v4, actions/checkout@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Build
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/cache@v4, actions/checkout@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Playwright Tests - chromium (2/2)
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/checkout@v4, actions/download-artifact@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Playwright Tests - firefox (2/2)
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/checkout@v4, actions/download-artifact@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Playwright Tests - firefox (1/2)
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/checkout@v4, actions/download-artifact@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Playwright Tests - webkit (2/2)
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/checkout@v4, actions/download-artifact@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Playwright Tests - chromium (1/2)
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/checkout@v4, actions/download-artifact@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Playwright Tests - webkit (1/2)
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/checkout@v4, actions/download-artifact@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Merge Playwright Reports
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: actions/checkout@v4, actions/download-artifact@v4, actions/setup-node@v4, actions/upload-artifact@v4. Actions will be forced to run with Node.js 24 by default starting June 2nd, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
Build
{ "workflowData": { "owner": "TypeCellOS", "repo": "BlockNote", "sha": "201b9946ffef2ec7c68c8a31e09425243e77fe19", "ref": "2582" }, "key": "vJfQhzAg36", "runId": 23389909182, "webhookDebug": { "action": "requested", "head_branch": "docs/react-hooks-jsdoc", "head_repository_full_name": "TypeCellOS/BlockNote", "full_name": "TypeCellOS/BlockNote", "isPullRequest": true, "prNumber": 2582, "prNumberType": "number", "isNewPullRequest": true, "isOldPullRequest": false, "prKey": "TypeCellOS/BlockNote:docs/react-hooks-jsdoc", "oldPrDataHash": "E0V3ILpxpF", "lookupKey": "TypeCellOS/BlockNote:docs/react-hooks-jsdoc", "data": { "owner": "TypeCellOS", "repo": "BlockNote", "sha": "201b9946ffef2ec7c68c8a31e09425243e77fe19", "ref": "2582" } } }
🎭 Playwright Run Summary
40 passed (35.1s)
🎭 Playwright Run Summary
40 passed (45.5s)
🎭 Playwright Run Summary
12 skipped 72 passed (1.4m)
🎭 Playwright Run Summary
40 passed (1.0m)
🎭 Playwright Run Summary
1 flaky [chromium] › src/end-to-end/keyboardhandlers/keyboardhandlers.test.ts:77:7 › Check Keyboard Handlers' Behaviour › Check Enter preserves nested blocks for empty block 2 skipped 81 passed (1.4m)
🎭 Playwright Run Summary
1 flaky [webkit] › src/end-to-end/customblocks/customblocks.test.ts:10:7 › Check custom block functionality › Should be able to interactively update vanilla custom blocks 10 skipped 73 passed (1.8m)

Artifacts

Produced during runtime
Name Size Digest
blob-report-chromium-1 Expired
5.39 MB
sha256:3830971a5101397f609a78318c8afd3d9a273c3d872a70997bc54dbd251728d8
blob-report-chromium-2 Expired
48.6 KB
sha256:f2a7e21148af64d13c4c9f52983cdc17f9d883fcf433b67ce025b64fba4cddb2
blob-report-firefox-1 Expired
103 KB
sha256:db3575da3f140b5145c223a95822f27d727298eae59675fbc018344892ba3d27
blob-report-firefox-2 Expired
49.5 KB
sha256:f7bc04fd491689931ad008156c0ab10fd92b57210a3a326b8f364b8913e98d31
blob-report-webkit-1 Expired
480 KB
sha256:b1d0d0dbd5574f97562c3cc33925e924f194aaa571bb65d3474c7d8f6fd7d3eb
blob-report-webkit-2 Expired
49.5 KB
sha256:775ac6b4df807f39c7d075feaf6a98f311ebb1a501908ec2be73c809ded02481
playwright-build Expired
26.2 MB
sha256:9254ee406e42133796631cb756b72d93c1eec3bf7cab95ef9d1fa0064b104f2a
playwright-report-chromium-1 Expired
5.89 MB
sha256:ec65aa89a6ccbe0f5b9e82ca378d0df3f9797c15f84a27247b7a71f895281a72
playwright-report-chromium-2 Expired
207 KB
sha256:0ab060f042c524a34a8dbad0c87583e0e86138c78eda3287fe0b1d24dd1fc5bd
playwright-report-firefox-1 Expired
240 KB
sha256:f85129d3c9f5ebe92fabe19eab6fb71e85cdb15e292802549a718456926429ed
playwright-report-firefox-2 Expired
207 KB
sha256:9f7beb45d3160414564d7360c276f301e78f3d93ceba377096c6ed714005828a
playwright-report-merged Expired
6.27 MB
sha256:db446c064b0414f52cd62fc723d70f49adb288dd0f1f14fc43ca3bf7d447b715
playwright-report-webkit-1 Expired
961 KB
sha256:5e543ce89f2b18726c36eff2ee446f71e9f53683f5f3d6e322d5ad9b711dcb0e
playwright-report-webkit-2 Expired
208 KB
sha256:a06f7b049405155f5c2cb6fd1d47188af42532114541307f9b8615c5718c85db
relative-ci-artifacts-editor
46.8 KB
sha256:15860070c863dff8a9e953d1062313b81ebfeba475c3853b797b3e1182c3f0a0