Skip to content

chore: upgrade to Docusaurus 3.7 #11262

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: upgrade to Docusaurus 3.7 #11262

wants to merge 1 commit into from

Conversation

benmccann
Copy link
Contributor

@benmccann benmccann commented May 31, 2025 •
edited
Loading

PR Checklist

Overview

Upgrades to Docusaurus 3.7. It would be nice to upgrade to Docusaurus 3.8, but I can't figure out how to do that with this repo's setup. See here for my attempt at that: #11260

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @benmccann!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@netlify Netlify
Copy link

netlify bot commented May 31, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 1ad48bd
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/683b22f2c741f4000848fe32
😎 Deploy Preview https://deploy-preview-11262--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 88 (🔴 down 9 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (🟢 up 2 from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented May 31, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 1ad48bd.

Command Status Duration Result
nx run-many -t typecheck ✅ Succeeded 2m 5s View ↗
nx run-many -t lint ✅ Succeeded 10s View ↗
nx test eslint-plugin --coverage=false ✅ Succeeded <1s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded <1s View ↗
nx test eslint-plugin-internal --coverage=false ✅ Succeeded <1s View ↗
nx run types:build ✅ Succeeded 9s View ↗
nx run integration-tests:test ✅ Succeeded <1s View ↗
nx run generate-configs ✅ Succeeded 10s View ↗
Additional runs (27) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-05-31 15:45:26 UTC

JoshuaKGoldberg
JoshuaKGoldberg reviewed Jun 9, 2025
View reviewed changes
packages/website/package.json
@@ -55,7 +55,7 @@
"typescript": "*"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.2.1",
"@docusaurus/module-type-aliases": "~3.7.0",
Copy link
Member

Choose a reason for hiding this comment

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

Almost everywhere else uses ^. I think the two existing ~s might have been unintentional. Is there a reason to go with ~ here?

If it doesn't make a strong difference, I'd think we'd rather stick with ^ for consistency.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The reason was because larger changes are needed to adopt 3.8. Ideally we'd just upgrade to 3.8, but I was having trouble with that given that I'm not a React developer. I don't know if those changes would be hard for someone familiar with Docusaurus and React, but they might be a bit beyond me.

Copy link
Member

Choose a reason for hiding this comment

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

Ah gotcha, so this is to make sure we don't accidentally bump to a 3.8 of something then? In that case if it makes it easier to not accidentally bump, that seems reasonable to me.

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Jun 9, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

🚀 Functionally it all looks good to me. Just checking in on the ^/~?

JoshuaKGoldberg
JoshuaKGoldberg requested changes Jun 9, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

(wrong lever)

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Jun 9, 2025
JoshuaKGoldberg
JoshuaKGoldberg approved these changes Jun 9, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

👍 assuming we'd switch back to ^ once 3.8 happens.

@JoshuaKGoldberg JoshuaKGoldberg added 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge and removed awaiting response Issues waiting for a reply from the OP or another party labels Jun 9, 2025
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Jun 9, 2025
Open
3 tasks
@benmccann
Copy link
Contributor Author

Yes, I was thinking we'd switch back to ^ for 3.8. You can see my attempt at it here: #11260. I'm not sure if I should leave it open or not as I'm not sure whether I can complete it, but it should be directionally correct and provide details about what needs to happen if there's someone who either wants to take it over or make their own attempt.

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

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@benmccann @JoshuaKGoldberg