What you’ll learn
  • how to upgrade Webiny from 5.39.x to 5.40.x

Make sure to check out the 5.40.0 changelog to get familiar with the changes introduced in this release.

Step-by-Step Guide

1. Upgrade Webiny Packages

Upgrade all Webiny NPM packages by running the following command:

Once the upgrade has finished, running the yarn webiny --version command in your terminal should return 5.40.2.

2. Run the Upgrade Command

The next step is to run the project upgrade:

3. Breaking Changes❗

This release contains a couple of breaking changes that might affect your project, if you’ve extended your project via plugins. If you’re using the default installation of Webiny without customizations, you can skip this section.

3.1 Removed Deprecated Backend APIs

As mentioned in the changelog, with this release, we’ve removed a couple of backend JavaScript APIs that were marked as deprecated in previous releases.

Essentially, we’ve removed a couple of older methods used for subscribing to lifecycle events and also for performing Headless CMS-related security permissions checks.

Before deploying, please refer to the separate Removed APIs article, and make sure to update your project code, if necessary.

3.2 Removed/Replaced Frontend APIs

We’ve also upgraded some of the Admin app components and plugins, namely Form, AppPbWebsiteSettings, and FileManagerFileTypePlugin.

Before deploying, please refer to their respective sections in the Removed APIs article, and make sure to update your project code, if necessary.

3.3 Pulumi V6 Upgrade

With this release, we’ve upgraded the Pulumi version to v6. Make sure to check the dedicated Pulumi v6 article for more information on this one.

3.4 Page Builder -themeFolder Updates

With this release, we’ve made a couple of changes within the apps/theme folder. For more information, we recommend you take a look at the Theme Folder Updates article.

4. Run Builds Locally

To verify that your project was correctly upgraded and is ready to be deployed, run the following commands:

If these execute successfully, you’re ready to move on to the next step, and deploy your project.

5. Deploy Your Project

Proceed by redeploying your Webiny project:

Make sure you deploy the entire system using the command shown above! You have to deploy all apps before using the system. Partial deploys will cause the upgrade to be applied incorrectly.
As stated in the Upgrade Webiny section, we recommend that you first deploy your changes into one of your pre-production environments, like dev or staging.
Learn more about different deployment environments in the CI/CD / Environments key topic.