Upgrade instructions for Configured Commerce SDK LTS
Note
These instructions are for upgrading from 5.2 to LTS (long-term support). To upgrade from 5.1, follow the instructions for upgrading to 5.2instructions for upgrading to 5.2 first.
Follow the steps below to upgrade the Optimizely Configured Commerce SDK.
Update SDK-supplied source files
There are two possible approaches.
Approach 1
- Unzip the latest LTS SDK.
- Copy the following from the LTS SDK folder into your project:
- src/FrontEnd//.
- src/InsiteCommerce.Web//.
Note
Check for any customizations you may have made that are overwritten.
Approach 2
- Unzip the latest 5.2.0 SDK.
- Unzip the latest LTS SDK.
- Compare the /src folder to see what changes were made for the new SDK. If doing so, exclude /src/InsiteCommerce.Web/_SystemResources.
Update package references
For any C# projects, update them to reference the appropriate LTS version of Insite.Commerce.Public and Insite.Commerce.Private.
Build and test
Note
LTS (starting from 5.2.2508) includes support for .NET 8 and .NET 48. The SDK zip includes everything required to run the .NET 8 version. See .NET 8.0 local development environment.NET 8.0 local development environment for information.
- Compile to identify any breaking changes and resolve them.
- Attempt to run the site with the new code in place and identify inconsistencies.
- Determine which new features are desired.
- Use the Responsive theme to weave in any new changes (if you use the Classic CMS).
- Build Spire using your blueprint to address any breaking changes in your blueprint (if you use the Spire CMS).
Key features
See the Long-term support release notesLong-term support release notes for included features.
Breaking changes
Optimizely attempts to minimize breaking changes, but sometimes they are inevitable. The specific changes are detailed in the cumulative spreadsheet attached to each set of release notes, but it may be easier to look for compilation problems and remediate them individually. (Note the two tabs at the bottom of the spreadsheet: one for cumulative breaking changes, one for Spire breaking changes.)