Brightspot Dependency Version Upgrades Guide

Update the Brightspot version number in the root build.gradle in accordance to the referenced versions above.

After updating this version, resolve any build errors. Refer to the troubleshooting guide below for more help.

Update the Component-Lib version number in the root build.gradle in accordance to the referenced versions above.

Update the Brightspot GO version number in the root build.gradle in accordance to the referenced versions above.

Below are the known breaking changes for Brightspot upgrades and Component-lib.

Brightspot

ContentEditDrawerWriter interface removed

The interface ContentEditDrawerWriter has been removed and replaced with a different implementation.

Resolution:

Remove all implementations of ContentEditDrawerWriter. Historically, these have only existed on brightspot.core.page.OneOffPage , but check the entire code base.

New implementation: ContentEditDrawerItem

See Adding 4.5 Features to Your Project Guide (Shelf)

ToolRequest.localizeText was removed

In 4.5, the method ToolRequest.localizeText was removed, and will cause build errors after upgrading.

Resolution:

Replace usages of ToolRequest.localizeText with ToolLocalization.text.

Before:

ToolRequest.localizeText(this, "placeholder.required"); 

After:

ToolLocalization.text(this, "placeholder.required"); 

ListMergeStrategy interface relocation

After upgrading, you may run into an error such as:

brightspot.core.cascading.listmerge.ListMergeStrategy<NavigationLink> is not compatible with brightspot.listmerge.ListMergeStrategy<NavigationLink>
  where T is a type-variable:
  
error: getMergeStrategy() in ModuleTypeListValueOverrideAfter cannot override getMergeStrategy() in AbstractListValueOverride

Resolution:

You will need to change the import path of ListMergeStrategy to the relocated package.

Old: brightspot.core.cascading.listmerge.ListMergeStrategy

New: brightspot.listmerge.ListMergeStrategy