Skip to main content

Version: 23.10

Upgrade to a new release

Journey Workspaces is a Create React App (CRA) template that leverages all existing capabilities of Create React App.

There are two ways to upgrade to a new Journey Workspaces release:

  1. Create a new CRA app, then copy your configs to the new app's repo folder.
  2. An in-place upgrade of your existing CRA app.

Upgrade with a new CRA app​

When you create a new template project using npx create-react-app my-app --template @journey-ui/cra-template-ws@23.10.0, the latest version of react-scripts is installed which means you get all the latest Journey Workspaces features and improvements in newly created apps automatically.

Once you have your new CRA application folder, copy over the configs from your existing application, keeping in mind that there may be differences in config file formats between Journey Workspaces releases.

We have simplified the way upgrades are executed. Bumping the @journey-ui/workspaces version in package.json and running npm install in this folder should be enough, but there can be breaking changes. 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 the migration guide for this release.

In-place upgrade of an existing CRA app​

To upgrade an existing CRA app in-place, you need to change the app version in the package.json system file. You may also need to make changes to your config files.

To update the CRA app version:

  1. Open package.json, located in the root folder of your application's repo.
  2. Replace the "@journey-ui/workspaces" version with "^23.10.0" as follows:
      "dependencies": {
        ...
        "@journey-ui/workspaces": "^23.10.0",
        ...
      },
  3. Save package.json.
  4. Run npm install to pull in the new library dependencies.

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. To learn about config files, see the Configuration section of this documentation.