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

Update dependencies (Docusaurus v3) #142

Merged
merged 13 commits into from
Jul 12, 2024

Conversation

YetAnotherClown
Copy link
Collaborator

@YetAnotherClown YetAnotherClown commented May 28, 2024

This PR updates all dependencies for the CLI and Docusaurus Plugin to their latest major versions, with necessary changes for any breaking changes. The notable change here is the update to Docusaurus v3.

This build successfully works on roblox-lua-promise, Nevermore, and some of my own projects.

Changes:

  • The minimum required version of Node is now 18, as this is now the minimum supported version of many of the updated dependencies.
  • docusaurus-preset-classic now has a default remark plugin for admonitions, remark-admonitions is no longer needed.
  • docusaurus-lunr-search no longer requires theme/SearchBar folder.
  • To resolve issues with the new Docusaurus brokenLinks and brokenAnchorLinks detector, any top-level category in the table-of-contents in any moonwave class that has no children will be removed, resulting in no broken anchor link.
  • The changelog page resulted in a brokenLink error, to resolve this, the changelog will now be stored as changelog.md instead of CHANGELOG.md in the temporary directory.

Known Issues:

This is no longer required in newer versions of `docusaurus-lunr-search`
Latest versions of `gh-pages` return a promise from `publish()` now
The updated dependencies no longer support anything below Node 16
`codespan-reporting` introduced a change that collapses multi-line outputs, breaking some old snapshots. This reverts this change to preserve old snapshots.
Docusaurus requires Node.js version >=18.0
The broken links detector expects the changelog page to be lowercase, while we have it as all uppercase
…s, or functions

To fix this, we remove any of the top-level categories in the toc if they contain no children
@YetAnotherClown YetAnotherClown marked this pull request as ready for review May 31, 2024 21:15
@YetAnotherClown
Copy link
Collaborator Author

I recently tested this branch on the Nevermore repository. The update to Full-Moon to 1.19.x crashes when used on large repositories such as Nevermore, it builds successfully without the version bump.

Full-Moon 1.0.0 will fix this, but it is not yet released besides pre-releases. I will be moving the updates to the extractor in this PR to a new draft PR with changes to prepare for Full-Moon 1.0.0.

@YetAnotherClown
Copy link
Collaborator Author

Also, the diff from the lock files is pretty huge, should I create a .git-blame-ignore-revs file to hide the commit from the diff?

These changes have been moved, see (evaera#147)
@YetAnotherClown
Copy link
Collaborator Author

Extractor changes have been moved to #147, with changes to prepare for full-moon 1.0.0 release and file paths in full-moon errors.

@YetAnotherClown YetAnotherClown merged commit d31bff1 into evaera:master Jul 12, 2024
1 check passed
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

Successfully merging this pull request may close these issues.

1 participant