What you’ll learn
  • how to upgrade Webiny from 5.9.0 to 5.10.0

Before continuing, make sure to take the necessary precautions, listed in the Overview section.

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

1. Project Preparation
anchor

First, we need to prepare your project for the upgrade process. We renamed our shared Elasticsearch package from api-plugin-elastic-search-client to api-elasticsearch, and we need to update package.json files that are using it, before attempting to upgrade packages using yarn.

In your project root, run the following:

2. Upgrade Webiny Packages
anchor

We’re now ready to upgrade all @webiny/* packages! Run the following command:

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

Before moving on, make sure you commit all your changes.

3. Run the Upgrade Command
anchor

Now let’s run the project upgrade:

The upgrade script will make a couple of changes to your existing API project application’s code (located within the api folder). Once the upgrade command has finished, you can run the git statusexternal link command to see all changes that the command performed.

4. Deploy Your Project
anchor

Finally, proceed by redeploying your Webiny project:

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.