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 docusaurus to v3.6.3 #251

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Bump docusaurus to v3.6.3 #251

merged 2 commits into from
Dec 20, 2024

Conversation

maxrake
Copy link
Contributor

@maxrake maxrake commented Dec 14, 2024

This change bumps the version of docusaurus from v3.5.2 to v3.6.3.

The new "Docusaurus Faster" feature added in v3.6.0 was applied with a feature flag in the config. It makes use of SWC js loader, which allows for removing the Babel config file at site/babel.config.js. It also uses rspack instead of webpack, which required a few small changes to the config (mostly naming and comment reminders). Overall, using the new features allows the site to build in one third the time as before, at least when measured from local builds.

The changes were tested locally by successfully building and serving the site. Changelogs for the versions included in this upgrade:

@maxrake maxrake self-assigned this Dec 14, 2024
@maxrake maxrake requested a review from a team as a code owner December 14, 2024 00:31
Copy link

phylum-io bot commented Dec 14, 2024

Phylum OSS Supply Chain Risk Analysis - INCOMPLETE

The analysis contains 1 package(s) Phylum has not yet processed,
preventing a complete risk analysis. Phylum is processing these
packages currently and should complete soon.
Please wait for up to 30 minutes, then re-run the analysis.

View this project in the Phylum UI

This change bumps the version of `docusaurus` from v3.5.2 to v3.6.3.

The new "Docusaurus Faster" feature added in v3.6.0 was applied with a
feature flag in the config. It makes use of SWC js loader, which allows
for removing the Babel config file at `site/babel.config.js`. It also
uses `rspack` instead of `webpack`, which required a few small changes
to the config (mostly naming and comment reminders). Overall, using the
new features allows the site to build in one third the time as before,
at least when measured from local builds.

The changes were tested locally by successfully building and serving the
site. Changelogs for the versions included in this upgrade:

* [v3.6.0](https://github.com/facebook/docusaurus/releases/tag/v3.6.0)
* [v3.6.1](https://github.com/facebook/docusaurus/releases/tag/v3.6.1)
* [v3.6.2](https://github.com/facebook/docusaurus/releases/tag/v3.6.2)
* [v3.6.3](https://github.com/facebook/docusaurus/releases/tag/v3.6.3)
Copy link

phylum-io bot commented Dec 16, 2024

Phylum OSS Supply Chain Risk Analysis - SUCCESS

The Phylum risk analysis is complete and has passed the active policy.

View this project in the Phylum UI

@maxrake
Copy link
Contributor Author

maxrake commented Dec 16, 2024

Building the site with these changes in CI takes 8s, down from the 28s it took previously. Rust is speeding up everything these days!

Copy link
Contributor

@kylewillmon kylewillmon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

site/docusaurus.config.js Show resolved Hide resolved
@maxrake maxrake merged commit 0309f55 into main Dec 20, 2024
2 checks passed
@maxrake maxrake deleted the bump_docusaurus branch December 20, 2024 20:19
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.

2 participants