chore: upgrade docsearch-react to v3 stable, bump dependencies #6752
Conversation
|
✔️ [V2] 🔨 Explore the source changes: 74c0ccd 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/62175c21bb34d00007cbfaff 😎 Browse the preview: https://deploy-preview-6752--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-6752--docusaurus-2.netlify.app/ |
| @@ -25,7 +25,7 @@ | |||
| "build:format": "prettier --config ../../.prettierrc --write \"lib/**/*.js\"" | |||
| }, | |||
| "dependencies": { | |||
| "@docsearch/react": "^3.0.0-alpha.50", | |||
| "@docsearch/react": "^3.0.0", | |||
There was a problem hiding this comment.
@shortcuts Is this safe?
There was a problem hiding this comment.
It is safe, but introduces a breaking change in DocSearch.
We now require users to provide an appId, which is a follow up of migrating to our new infra. All of the users have received their new credentials but not all of them migrated yet.
I believe upgrading will encourage people to migrate.
There was a problem hiding this comment.
Yes, I was asking on Discord as well, but thought it may be faster to ask here :P
This means it will break for a minority of our users, but they could and should have upgraded right?
There was a problem hiding this comment.
Yes, I was asking on Discord as well, but thought it may be faster to ask here :P
Sorry, I'll paste my answer to give users visibility on this too
This means it will break for a minority of our users, but they could and should have upgraded right?
Yes indeed, we are no longer maintaining the legacy infrastructure and are definitely pushing to the new infra, so this upgrade will also help!
There was a problem hiding this comment.
Yes, we already agreed on Discord to do this upgrade
Maybe it could be better to do it in a separate PR to make it clear there's a breaking change @Josh-Cena ?
We also need to update the validation to mark appId as required + link to the PR or blog post so that we can explain this better to users
There was a problem hiding this comment.
Uh, going to do it in this PR. This is the only significant bump anyways, otherwise I won't even put this in the changelog (I'm recently excluding some maintenance PRs from the changelog)
|
Size Change: +322 B (0%) Total Size: 782 kB
ℹ️ View Unchanged
|
|
✔️ [V2] 🔨 Explore the source changes: 928d889 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6217697412f0040008a326e6 😎 Browse the preview: https://deploy-preview-6752--docusaurus-2.netlify.app |
Josh-Cena
added
the
pr: breaking change
Josh-Cena
changed the title
|
Thanks, marked this as a slight breaking change to create some more visibility |
| @@ -25,7 +25,7 @@ | |||
| "build:format": "prettier --config ../../.prettierrc --write \"lib/**/*.js\"" | |||
| }, | |||
| "dependencies": { | |||
| "@docsearch/react": "^3.0.0-alpha.50", | |||
| "@docsearch/react": "^3.0.0", | |||
There was a problem hiding this comment.
Yes, we already agreed on Discord to do this upgrade
Maybe it could be better to do it in a separate PR to make it clear there's a breaking change @Josh-Cena ?
We also need to update the validation to mark appId as required + link to the PR or blog post so that we can explain this better to users
Josh-Cena
changed the title
Breaking change
@docsearch/reactis now bumped to the v3 stable release. algolia/docsearch#1299 madeappIdrequired. Sites that haven't upgraded to the new DocSearch infra should do the migration in order to use the new dependency version.Motivation
A quick upgrade, because it helps us get rid of some patches (including the PnP patch)!
Have you read the Contributing Guidelines on pull requests?
Yes