Skip to content

chore: DOC-2016: Upgrade Docusarus to 3.8.1#7502

Merged
achuribooks merged 18 commits intomasterfrom
docusaurus-upgrade
Jul 28, 2025
Merged

chore: DOC-2016: Upgrade Docusarus to 3.8.1#7502
achuribooks merged 18 commits intomasterfrom
docusaurus-upgrade

Conversation

@achuribooks
Copy link
Contributor

@achuribooks achuribooks commented Jul 22, 2025

Describe the Change

This PR upgrades Docusaurus and its related dependencies to v3.8.1.

Jira Tickets

🎫 DOC-2016

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

@netlify
Copy link

netlify bot commented Jul 22, 2025

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 8cc4999
🔍 Latest deploy log https://app.netlify.com/projects/docs-spectrocloud/deploys/6883bf5697787500082b3f14
😎 Deploy Preview https://deploy-preview-7502--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@achuribooks achuribooks marked this pull request as ready for review July 22, 2025 16:02
@achuribooks achuribooks requested a review from a team as a code owner July 22, 2025 16:02
@achuribooks achuribooks added backport-version-4-0 auto-backport Enable backport backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 backport-version-4-5 Backport change to version 4.5 backport-version-4-6 Backport change to version 4.6 backport-version-4-7 Backport change to version 4.7 labels Jul 22, 2025
@achuribooks achuribooks changed the title Initial docusaurus upgrade chore: DOC-2016: Upgrade Docusarus to 3.8.1 Jul 22, 2025
@achuribooks achuribooks added the visual-tests Trigger the visual tests workflow label Jul 24, 2025
@github-actions
Copy link
Contributor

📋 Visual Report for branch docusaurus-upgrade with CI run 16526429122 and attempt 1 is ready at
https://spectrocloud.github.io/librarium/reports/docusaurus-upgrade/16526429122/1

💡 You may have to wait for DNS to resolve or the GitHub Pages job to complete. You can view the progress of the GitHub Pages job here.

@achuribooks achuribooks removed the visual-tests Trigger the visual tests workflow label Jul 25, 2025
@achuribooks
Copy link
Contributor Author

achuribooks commented Jul 25, 2025

Summary:

  • Visual tests passing after setting maxDiffPixels: 106 in playwright.config.ts. Docusaurus PR introduced "system mode" in addition to light/dark mode, which changed the icon (105 pixels) and caused tests to fail.
  • Setting useCssCascadeLayers: true decreases bottom padding of admonitions, causing some visual tests to fail. Since this will be required in Docusaurus v4, we are enabling it. No other consequences seen.
  • Setting ssgWorkerThreads: true causes Netlify builds to fail, though local builds work. Attempted to increase memory limit with Netlify environment variables and by upgrading Ubuntu Focal image, but Netlify builds still failed. As a result, we are keeping ssgWorkerThreads: false for now.

Tagging @addetz for visibility. Plan to complete upgrade Monday.

@achuribooks achuribooks merged commit 306da61 into master Jul 28, 2025
19 checks passed
@achuribooks achuribooks deleted the docusaurus-upgrade branch July 28, 2025 11:43
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 All backports failed

Status Branch Result
version-4-2 Backport failed because of merge conflicts
version-4-3 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-3:
- chore: add kapa branch (#4858)
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
- Create, style, and populate the Tutorials section (#2689)
version-4-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-4:
- chore: add kapa branch (#4858)
- chore: PAC-938-packs data initial fetch and component development for readme (#3178)
- Create, style, and populate the Tutorials section (#2689)
version-4-5 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-5:
- docs: allow custom logos in Docs DOC-1886 DOC-1893 (#6966)
- chore: add kapa branch (#4858)
version-4-6 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-6:
- docs: allow custom logos in Docs DOC-1886 DOC-1893 (#6966)
version-4-7 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

backport --pr 7502

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.7.10 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Enable backport backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 backport-version-4-5 Backport change to version 4.5 backport-version-4-6 Backport change to version 4.6 backport-version-4-7 Backport change to version 4.7 released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants