Broadleaf Microservices
  • v1.0.0-latest-prod

Upgrade to 2.2.0

May 12, 2025

A caching issue was identified in the 2.2.0-GA Release Train when using ContentServices. If you are using ContentServices, please see this documentation for remediation, which can include either upgrading your ContentServices version to 2.0.7-GA, or introducing the recommended workaround in lieu of an upgrade.

April 28, 2025

An issue was identified in the 2.2.0-GA Release Train when using Stripe payment gateway module. If you are using the Stripe module, have released a 2.2.0.1-GA Release Train to resolve the issue. More details can be found here:

April 16, 2025

Tip
The 2.x versions are Spring Boot 3 compatible.
Tip
If coming from a version prior to 2.0.0-GA, then see the 2.0.0 upgrade guide.

Requirements

  • Java 17 is required since 2.0.0-GA.

Notable Changes

Tip
Also see Upgrade 2.1.4-GA upgrade guide. Upgrade 2.2.0 also contains the changes noted in the 2.1.4 Upgrade.

Starter Project Updates

  • Alongside the existing Heat Clinic demo, is now a new Telco Demo starter extension available. See the Broadleaf Initializr for more details.

TMForum Support

Broadleaf has joined TMForum as a member and has expanded various framework capabilities in service of achieving TMForum API certification.

Please see the individual project release notes below for more information.


Feature/Notable Change Impacted Services Links

Introduced Relevancy Rules

SearchServices, AdminServices, AuthenticationServices, AdminWeb

Added support for recurring/usage prices, recurring discounts, and free trials

PricingServices, OfferServices, PricingClient, OfferClient

Added support for pre-order and backorder inventory

InventoryServices, OrderOperationServices, OrderServices

Added support for characteristics and product terms

CatalogServices, CatalogBrowseServices

Added support for Offer Templates

OfferServices

Refactored Quote React to split out new commerce-shared-react library

Commerce Microfrontend

Common concerns such as icons, the component registrar and renderer, and the client registrar were moved to the @broadleaf/commerce-shared-react library.

Tip
Nothing is required for adopting Relevancy Rules beyond normal version changes to Release Train, but details may be found in Search Services release notes including required Auth permissions and scopes. There is also no need to perform a full Solr reindex after upgrading since Relevancy Rules are applied at query time.

Security

To review the security related content, see 2.2.0 notes.

Tip

You will need your login credentials originally provided for accessing the Broadleaf nexus. Security fixes often involve dependency updates to remediate issues being tracked in external OSS components. It is worth considering adopting releases with security fixes (even Broadleaf Severity LOW) to avoid any possibility of transitive exposure in your codebase.

Frontend Compatibility and Release Notes

Microservices release 2.2.0 is congruent with: