4.5 Table of Contents

This upgrade guide provides a step by step process for performing an upgrade of an existing project to the latest version of Brightspot 4.5 and covers a majority of scenarios or issues that may occur during an upgrade.

If you believe anything is missing from the documentation, please reach out to your Brightspot representative to ensure that we can continue to keep this up to date and accurate.

Before beginning an upgrade, we should verify the state of the initial build. The outcome of this step will help guide some steps later in the upgrade process.

TCT is a test that ensures the expected theme JSON structure is compatible with the view structure generated by Brightspot Styleguide. You should verify the state of this before making any code changes, since in some cases, TCT may not be installed or executing properly.

During the upgrade process, it is important to not introduce new TCT errors, but if TCT isn’t running/installed/configured, we need to know since fixing TCT errors directly is separate from the general upgrade process and can be done afterward.

Below is a guide on how to verify TCT and make necessary configuration changes.

Shadowed code is code that is forked from platform code, and overrides classes/files that would otherwise be accessible through a library dependency.

Please follow the guide below carefully to resolve/analyze any shadowed code.

Before beginning an upgrade on the project, analyze all shadowed code thoroughly and document the analysis. This analysis is critical for providing context for remediation.

We need to upgrade the Styleguide in all bundles on the project. There is usually only one bundle, but it is important to ensure that all bundles are updated if more than one exist.

More documentation on how to use the latest Brightspot Styleguide can be found here: https://www.brightspot.com/documentation/brightspot-cms-developer-guide/latest/theme-guide#introduction-to-theming

Refer to the versions and procedures in the following linked guide.

If upgrading from an older version, you might run into dependencies that are no longer supported when upgrading to the latest Brightspot version.

Below is a guide detailing some of the dependencies that are no longer supported, and some steps to resolve these dependencies before beginning the rest of the upgrade.

If this isn’t done first, it can cause later builds to fail since the dependencies are no longer supported in newer versions.

Refer to the below guide for upgrading Gradle on the project.

Every project being upgraded to 4.5 includes certain features that are added automatically. For other features, developer intervention is required. To view a list of all of these features, please refer to the 4.5 Product Guide.

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

After completing all previous steps, we will fix some known errors that arose during the 4.2 to 4.5 transition.

For customers hosted on Brightspot Cloud, follow the below guide for upgrading your Java version and Tomcat container version.

Upgrade Github Actions workflows

Contact your account representative for an updated Github Actions Workflow implementation.