Core Development Concepts > Basics
User Project Upgrade
Learn about how to do a project upgrade
- what is Webiny project upgrade
- what are the steps to upgrade a project
Overview
As a part of our upgrade process, we provide a way to update your codebase on each new release - at least what we can do automatically.
To start the project upgrade use the yarn webiny upgrade command.
Steps
When a user runs the yarn webiny upgrade command, there are multiple steps depending on what are we upgrading in that version.
There might even be some breaking changes, so we need to notify the user about them.
1. Notify the User About Breaking Changes
The first step is to notify the user about breaking changes:
User needs to press y to continue with the upgrade process.
Note that this step will not show if there are no breaking changes in the version user is upgrading to.
2. Check User Project Dependency Versions Against the Webiny Dependency Versions
Next step, which will always be executed, is to check if the user project dependencies are in sync with the Webiny dependencies. If they are not, the user will be prompted to update them.
We ship Webiny with the dependencies that are working with our code. If it is possible, our users should keep their dependencies in sync with Webiny ones to avoid any unexpected problems.
User is encouraged to press y to update all dependencies in their project.
If user chooses not to upgrade the dependencies, the upgrade process will prompt once more:
If user chooses to continue without updating the dependencies, the upgrade process will continue, but it is not recommended.
Version Specific Steps
All steps after the dependency check are specific to the version user is upgrading to.