Skip to main content

Version: 24.04

Upgrade to a new release

Overview​

Upgrading Journey Brokers to a new release is a multi-step process that starts with a new or upgraded CRA app followed by other release-specific changes, some optional, some required. This guide describes the upgrade process in detail so that you understand how to upgrade your Journey Brokers solution.

In addition to this guide, each Journey Brokers release comes with a release-specific upgrade guide that provides all the information you need to upgrade from the previous Journey Brokers release. Upgrade guides for patch releases are also available when required. This release includes the following additional upgrade guides:

info

If a Workspaces release contains multiple patches, we recommend upgrading to the latest patch release.

Upgrade a CRA app​

Journey Brokers is a Create React App (CRA) template that leverages all existing capabilities of Create React App. There are two ways to upgrade a CRA app to a new Journey Brokers release:

  • Migrate: Create a new CRA app, then copy your configs to the new app's repo folder.
  • In-place upgrade: An in-place upgrade changes the version of your existing CRA app.

Regardless, of which approach you use, each new release may introduce changes that you need to address after upgrading your CRA app. For information about what's changed in this release, including configuration and breaking changes, see Upgrade from 23.10 to 24.04.

Migrate to a new CRA app​

To migrate a new CRA app, follow these steps.

  1. Start by creating a new template project. For example:

    npx create-react-app my-app --template @journey-ui/[email protected]

  2. Copy the configs from your existing application to the new CRA application folder keeping in mind that there may be differences in config file formats between Journey Brokers releases. To learn about config files, see the Configuration section of this documentation.

  3. Address any breaking changes introduced by the new release. To learn about breaking changes in this release, see Breaking changes below.

In-place upgrade of an existing CRA app​

We have simplified the way in-place upgrades are executed. This involves updating your CRA app's version, checking for any configuration changes, and addressing any breaking changes.

To upgrade an existing CRA app in-place, follow these steps.

  1. Start by updating the package.json file. Open package.json, located in the root folder of your existing application's repo, change the "@journey-ui/workspaces" version, and save your changes. It should look like this:

    "dependencies": {
        ...
        "@journey-ui/workspaces": "^24.4.1",
        ...
    },
    info

    If a Workspaces release contains multiple patches, we recommend upgrading to the latest patch release.

  2. Install the new app version and its library dependencies. Run the following command:

    npm install

  3. You may need to make changes to your config files. To learn about config files, see the Configuration section of this documentation.

    tip

    If your application fails to start after making the system file changes above, this may be because the format of the config files has changed. Check for errors in your terminal to determine if this the cause.

  4. Address any breaking changes introduced by the new release. To learn about breaking changes in this release, see Breaking changes below.

Breaking changes​

When you upgrade a CRA app to a new release, you need to address any breaking changes introduced in that release. While we endeavour to keep the number of breaking changes small to minimise the impact on upgrades, sometimes these are necessary. To learn about breaking changes in this release, see Upgrade from 23.10 to 24.04.

Upgrade from an older release​

Direct upgrade paths that skip releases aren't available. If you want to upgrade to this release (24.04) from a release earlier than the previous release (before 23.10), then you need to perform a sequence of upgrades starting from your existing release and continuing with each subsequent release until you reach your desired release.

For example, if you're currently on Journey Brokers 23.04 and you want to upgrade to this release (24.04), you need to start by upgrading from 23.04 to 23.10 then upgrade from 23.10 to 24.04, following the upgrade guides for each release. There's no direct upgrade path from 23.04 to 24.04.