Prepare a project for Spryker Code Upgrader

Last updated:
Edit on GitHub

Before you can start managing the upgrades of your project with Spryker Code Upgrader, fulfill the following prerequisites.

Update all Spryker modules to version 2022.04 or higher

The Upgrader provides automatic minor and patch updates for the current version of each module. Since most updates are released for the latest module versions, modules need to be of the latest major version. To do that, in composer.json, update all spryker-feature-* packages to version 2022.04 or higher.

To check if your module versions are supported by the Spryker Code Upgrader, Run the evaluator tool.

Make your code compliant with Upgradability Guidelines

Spryker Upgradability Guidelines contain rules that ensure code compliance with Spryker development and customization guidelines. When an application is compliant with the guidelines, it can take minor and patch updates without breaking functionality, even if it is highly customized.

Implement E2E testing in development workflow

Upgrades are provided as PRs that are automatically created in a project’s repository. To make sure all business functionality works as expected, you will need to review and test the PRs before merging.

Migrate to a supported version control system

Currently, the Upgrader supports GitHub, GitLab and Azure. If you want to use a different version control system, contact support, so we can implement its support in future.

Migrate to Spryker Cloud Commerce OS

The Upgrader supports only projects that run on Spryker Cloud Commerce OS (SCCOS). If you are running Spryker on premises, migrate to SCCOS.

Minimum technical requirements

For a smooth experience, make sure that your environments meet the minimum technical requirements:

Optional: Implement headless design

The Upgrader does not evaluate frontend customizations. You can either move to headless or apply frontend upgrades manually.

Optional: Make your code compliant with the supported extensions scenarios

To make sure you can take updates, stick to the recommended extension points when customizing your project.

Next steps

Onboard to Spryker Code Upgrader