Repository navigation
chore(algolia): upgrade algoliasearch to v5 - #10672
Merged
Merged
Conversation
Loading
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Notes from @slorber
This
algoliasearch@v5upgrade is not considered a breaking changeIt's encapsulated in
@docsearch/reactand in our@theme/SearchPagecomponent.Also, it was released as a
@docsearch/reactv3 patch release so newly initialized Docusaurus v3 sites are already usingalgoliasearch@v5Motivation
Algolia has released a new major version of the javascript search client.
Since DocSearch is now using the new version, we can also upgrade the
docusaurus-theme-search-algoliapackage to use the latest version of the js client and of DocSearch.There are a few changes to do in the code to accommodate the new version but nothing breaking, it's mostly around types and imports.
Test Plan
The existing tests are enough to test that every works, I also tried the local website and the search is working, with the user agent containing the latest version.
Test links
Deploy preview: https://deploy-preview-10672--docusaurus-2.netlify.app/