Prepare a project for Spryker Code Upgrader

Last updated:
Edit on GitHub

To start managing upgrades with Spryker Code Upgrader, fulfill the following prerequisites.

Make your code compliant with upgradability guidelines

Our upgradability guidelines ensure your project stays upgradable. When an application is compliant with the guidelines, it can take minor and patch updates without breaking functionality, even if it is highly customized.

To check if your code is compliant with the guidelines, run the evaluator tool.

Optional: Make your code compliant with the supported extensions scenarios

By sticking to the recommended extension points when customizing your project, you avoid making manual code changes after taking automatic updates.

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. Because 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 Upgrader, run the evaluator tool.

Implement E2E testing in development workflow

Upgrades are provided as PRs that are automatically created in a project’s repository. To make sure all 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 cloud

The Upgrader supports only projects that run in cloud environments. If you are running Spryker on premises, migrate to cloud.

Fulfill minimum technical requirements

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

  • PHP 8.1+. The Upgrader supports a minimum version of PHP 8.0. However, PHP 8.0 reached end of life in November 2023, so make sure to update PHP to the recommended version. To check if your PHP version is supported, run the evaluator tool.
  • Composer 2.5+
  • Git 2.24+
  • PHPStan 1.9+
  • PHPCodeSniffer 3.6.2+

Optional: Implement headless design

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

Next steps

Get access to the Upgrader