Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump dependency versions and handle breaking changes #88

Closed
egdmrsy opened this issue Nov 20, 2023 · 0 comments
Closed

Bump dependency versions and handle breaking changes #88

egdmrsy opened this issue Nov 20, 2023 · 0 comments
Assignees

Comments

@egdmrsy
Copy link
Collaborator

egdmrsy commented Nov 20, 2023

Version updates

Breaking Change

  • @Docusaurus packs from 2.4.1 to 3.0.0
  • @mdx-js/react from 1.6.22 to 3.0.0
  • react and react-dom from 17.0.1 to 18.0.0

Other packages are updated to minor versions. (No breaking changes)

Breaking Change Notes

Docusaurus v3

  • New version uses @mdx-js/react v3. The syntax should now escape the < and { characters with a backslash in .md files. In current TruBudget typedoc generated api docs, this is not being done. The fix is to add the package @types/react to the TruBudget api folder, which will generate correct .md files.
  • New version has some structural changes, thus the @type imports had to be renamed (such as from DocPage to DocRoot) More info: Relevant Docusaurus PR
  • New version uses react v18 so react is also upgraded.
  • Whatever package was providing the classnames, is no longer providing it as a dependency. That's why it is now added manually into dependency list.
  • Packages plugin-content-docs and @docusaurus/theme-search-algolia are removed from dependencies. These already come with the classic preset of the Docusaurus and are configured under docusaurus.config.js
@egdmrsy egdmrsy changed the title Bump React version to v18 Bump dependency versions and handle breaking changes Nov 20, 2023
@egdmrsy egdmrsy self-assigned this Nov 20, 2023
@egdmrsy egdmrsy closed this as completed Nov 29, 2023
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

When branches are created from issues, their pull requests are automatically linked.

1 participant