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

Merge main (v2.0.0) into develop #162

Merged
merged 2 commits into from
Sep 8, 2022

Conversation

yen-tt
Copy link
Contributor

@yen-tt yen-tt commented Sep 8, 2022

No description provided.

Yen Truong and others added 2 commits September 8, 2022 16:54
## Version 2.0.0

### Breaking Changes
- Upgraded search-headless dependency to V2. This means re-exported interfaces related to static filters and direct answers stems from search-headless V1 have been changed or removed in headless-react V2.
  - for more details, see the breaking changes listed in V2 [release notes](https://github.com/yext/search-headless/releases/tag/v2.0.0) and [documentation](https://github.com/yext/search-headless/blob/main/docs/search-headless.md) of search-headless
- `SearchHeadlessProvider` now takes in a `SearchHeadless` instance instead of a `SearchConfig` object. `SearchHeadlessProvider` will also no longer set vertical key, session tracking, and session id for the `SearchHeadless` instance. Users will need to create and initialize a Headless instance themselves. For more context, this change is made to prevent potential memory leaks, per Redux's recommendation that redux store (i.e. `SearchHeadless` instance) should not be instantiated within a render function. (#156)
- All exports marked as `@deprecated` in previous publish as part of the rebranding process, as well as `subscribeToStateUpdates`, is now removed in V2 (#153  )
  - for more details, the deprecated identifiers are listed in [v1.3 release notes](https://github.com/yext/search-headless-react/releases/tag/v1.3.0)
@yen-tt yen-tt requested a review from a team as a code owner September 8, 2022 21:57
@yen-tt yen-tt merged commit 146468c into develop Sep 8, 2022
@yen-tt yen-tt deleted the dev/merge-v2.0.0-addb3a7-into-develop branch September 8, 2022 21:58
@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.231% when pulling addb3a7 on dev/merge-v2.0.0-addb3a7-into-develop into 331292e on develop.

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.

None yet

2 participants