Overview of Theme and SDK Version Upgrades | Yext Hitchhikers Platform
What You’ll Learn
By the end of this unit, you will be able to:
- Locate the Search changelogs and use them to recall feature updates from various Theme and SDK versions
- List the differences and similarities between the Search UI SDK and Legacy Search Bar
- Recall when you need to update the SDK version
As you know, Search is an extremely iterative product. Search captures real-time search analytics which allows Hitchhikers to make data-driven decisions, whether that’s adding new entities into the platform or adjusting existing content.
As a Hitchhiker, it’s critical that you are aware of any upgrades that are released by the Yext team. Want to take advantage of all of the cool new features that our Product team releases? Then you’ll need to upgrade both the theme and the Search UI SDK in your Search experience.
Where to Find Information on Upgrade Versions
Within Search, there are a few pieces that have upgrade versions. Below is a table of them, links to their changelogs, and where to update the version numbers.
In this module, we’ll focus specifically on the first two: upgrades to the Search UI SDK and Hitchhiker Theme.
We post all updates to the theme and SDK changelogs within the Search reference documentation.
These posts will outline changes and bug fixes included with each version, including any upgrade implications or callouts to be aware of when you make the upgrade. A new Search UI SDK version will always be tied to a new Theme version, but the Theme is updated more frequently than the Search UI SDK. Let’s look at two changelog posts as examples:
- outlines the changes and new formatters included with the Hitchhiker Theme v1.24, including files you may need to re-fork (more on this later).
- notes changes and upgrade instructions for the Hitchhiker Theme v1.23, but also includes the Search UI 1.10, which means you’ll have to update the Search UI SDK when you upgrade the theme.
Why You Need to Update the SDK When Upgrading the Theme
The walks through everything you need to know about the library, including code to implement components yourself if you’re a developer. If you’re not a developer, the theme takes care of adding components and writing all this code for us.
The theme references the specific code from the SDK to build Search experiences. When you update the theme, you’ll want to also update the SDK version the theme is working with. If there is a new version of the SDK, there may be different code used to implement components. A new theme version will update the theme files to accommodate the changes in the SDK.
Since the theme files are built directly off of the SDK components, you’ll want to make sure they’re compatible with each other by using the latest versions of both.