chore: update docusaurus to 3.6.1 #1378
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces updates to the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
packages/docs/package.json (1)
35-37: Consider using consistent version specifiersThe version updates for dev dependencies are aligned with the main packages, which is good. However, consider using consistent version specifiers (^ vs exact) across all Docusaurus packages to prevent potential version mismatches during future updates.
- "@docusaurus/core": "3.6.1", - "@docusaurus/preset-classic": "3.6.1", + "@docusaurus/core": "^3.6.1", + "@docusaurus/preset-classic": "^3.6.1",
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (1)
packages/docs/package.json(2 hunks)
🔇 Additional comments (2)
packages/docs/package.json (2)
21-24: Verify Docusaurus 3.6.1 release notes and compatibility
The version updates look consistent across core Docusaurus packages. However, we should verify the changelog for any breaking changes or migration steps required.
Line range hint 21-37: Ensure proper testing of documentation site
Since this is a documentation framework update:
- Verify the build process works correctly using the
buildscript - Test the documentation site in a staging environment
- Check if all existing documentation features (search, mermaid diagrams, etc.) work as expected
- Consider updating the Docker build if necessary (Dockerfile is referenced in scripts)
mermaid' -t md
</details>
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
packages/docusaurus-tldraw-plugin/package.json (2)
Line range hint
6-8: Add test coverage for the pluginThe empty test script suggests missing tests. Consider adding tests to ensure the plugin's functionality with the new Docusaurus version.
Would you like me to help create a basic test suite for the plugin? This could include:
- Unit tests for the plugin's core functionality
- Integration tests with Docusaurus 3.6.1
Line range hint
1-4: Enhance plugin documentationWhile the description provides a basic overview, consider adding:
- A README.md with usage instructions
- Example configurations
- Compatibility requirements
Would you like me to help create a documentation template for the plugin?
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (1)
packages/docusaurus-tldraw-plugin/package.json(1 hunks)
🔇 Additional comments (1)
packages/docusaurus-tldraw-plugin/package.json (1)
13-13: Verify compatibility with the updated Docusaurus version
The update from 3.1.1 to 3.6.1 is a significant minor version jump. While it should maintain backward compatibility, please verify that:
- The plugin continues to function as expected with Docusaurus 3.6.1
- The tldraw dependency (2.4.4) is compatible with the new Docusaurus version
✅ Verification successful
Update to Docusaurus 3.6.1 appears safe
The plugin's integration with Docusaurus is minimal and focused on:
- Webpack configuration for
.tldrfiles - HTML tag injection for fonts
- No direct usage of Docusaurus APIs that could be affected by breaking changes
The 3.6.1 release notes show only bug fixes and maintenance updates, with no breaking changes that would affect this plugin's functionality. The tldraw integration is also straightforward through standard React components.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for breaking changes in Docusaurus 3.6.1 release notes
gh api repos/facebook/docusaurus/releases | jq -r '.[] | select(.tag_name | contains("3.6.1")) | .body'
# Look for any existing issues related to tldraw compatibility
gh api search/issues -f q='repo:facebook/docusaurus tldraw'
Length of output: 1789
Script:
#!/bin/bash
# Let's check the plugin's implementation to understand its integration points with Docusaurus
fd "index.js|index.ts" packages/docusaurus-tldraw-plugin -x cat {}
# Check if there are any tests
fd "test|spec|__tests__" packages/docusaurus-tldraw-plugin
# Check for any breaking changes in package.json between 3.1.1 and current
rg -A5 -B5 '"@docusaurus/core"' packages/docusaurus-tldraw-plugin/package.json
# Look for any tldraw-related imports or usage
rg "tldraw" packages/docusaurus-tldraw-plugin
Length of output: 2523
|
Seems like v.3.6.1 is buggy. The process won't exit even tho it has finished, causing the pipeline to run forever. |
Hva er endret?
Dokumentasjon / Storybook / testdekning
storiesiStorybook, eller så er ikke dette relevant.Skjermbilder eller GIFs (valgfritt)
Summary by CodeRabbit
@docusaurus/coredependency for the docusaurus-tldraw-plugin to enhance functionality.