Upgrades
Upgrades
Brightspot Enterprise 4.5 to 4.7 Developer Upgrade Guide

4.5 to 4.7 Table of Contents



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.


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

  • Brightspot: 4.7.14
  • Component-lib: 4.5.26
  • Brightspot-GO: Refer to below table
Current Version Range Upgrade To Version
0.x 0.19
1.x 1.6.x

When upgrading to 4.7, there are some breaking changes that need to be accounted for. Text CSS Class Groups This feature can be found under Global → RTE cluster → Text CSS Class Groups field.


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

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

Board View Release Notes / Documentation This feature is enabled by default. These implementations are required for the Drag and Drop functionality of the Board View to work correctly. If your project...

Previous Topic
Java 11 / Tomcat 9 Upgrade Guide
Next Topic
Adding 4.7 Features Guide
Was this topic helpful?
Thanks for your feedback.

Browse All Docs

Everything you need to know when creating, managing, and administering content within Brightspot CMS.

Dashboards
Publishing
Workflows
Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

Field types
Content modeling
Rich-text elements
Images
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

Google Analytics
Shopify
Apple News
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

Assets
Modules
Landing pages
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

Asset types
Module types
Page types