Skip to main content

4.7 to 4.8 Table of Contents

Introduction​

This upgrade guide provides a step by step process for performing an upgrade of an existing Brightspot application from version 4.5.x to the version 4.7.x, where .x represents the latest available patch. Covered scenarios may not be applicable to every codebase, so make sure to check for any prerequisite conditions before performing each step.

Please report any feedback including missing documentation, documentation errors or clarifications.

Clean diffs​

Brightspot recommends unnecessary file changes which result in noisy diffs. Brightspot also recommends disabling auto-formatting on your IDE/editor to ensure that no unintended formatting changes occur.

By ensuring that the diff is clean (i.e. no extra formatting changes), you can promote thorough reviews of the upgrade code by the reviewer, as well as avoid unexpected merge conflicts with the rest of your engineering team.

Flag/file any unexpected issues​

If anything occurs during an upgrade that is unexpected, or if something is unclear based on the documentation, make sure to flag it to a Brightspot representative. This will ensure that everything is being done correctly, and any gaps in documentation are handled.

Keep commits small and succinct​

Ensure that commits are small and specific to the task at hand. This can help reviews, but can also ensure that reverting changes is easier to execute (for example, if a lot of auto-formatting happened, Brightspot would want to ensure that can be easily undone).

Clean operation if active development​

If there is active development on the project that you are upgrading, discuss a plan with the project team before you begin to help avoid merge conflicts.

Relevant versions​

Below are the relevant versions to be used in the following guides:

  • Brightspot: 4.8.0-rc.2024.8.14
  • Component-lib: 4.5.26
  • Solr version: org.apache.solr:solr-solrj': '9.3.0'
  • Brightspot-GO: Refer to below table
Current Version RangeUpgrade To Version
0.x0.19
1.x1.7.x

Step 1: Breaking Changes​

Brightspot Enterprise 4.7 to 4.8 Developer Upgrade Guide → 4.8 Breaking Changes Guide

When upgrading to 4.8, there are some breaking changes that need to be accounted for.

Step 2: 4.8 Features​

On every project being upgraded to 4.8, we want to include some basic new feature implementation.

Follow the below guide for more information on implementing these features.

Brightspot Enterprise 4.7 to 4.8 Developer Upgrade Guide → Adding 4.8 Features Guide

Actionable Notifications Documentation In-CMS notifications are enabled by default. Optional configuration is available in Sites & Settings at the Global level. Email Actionable notifications are opt ...