Keeping a project upgradable

Edit on GitHub

Keeping software up to date is often a potential issue, especially when it comes to transactional business models with sophisticated requirements.

We established development customization guidelines to make sure that you build and always keep your project upgradable while continuing to benefit from Spryker’s customization flexibility.

Following these guidelines throughout your development lifecycle is key to an effortless upgrade experience, especially when your business requires highly complex customizations.

By keeping your project compliant with our development guidelines, you make sure that you can take both minor and patch updates without breaking anything. Additionally, if your project is enrolled into PaaS+, being compatible enables you to take updates automatically.

The following steps will help you understand what development strategies you can implement, how they affect upgradability, and what you need to do to keep your project upgradable.

Select a development strategy

A development strategy is the approach you follow when customizing a project. When choosing a strategy, take into account how it will affect the upgradability of your project.

To keep your project upgradable, we recommend using the following development strategies:

  • Configuration
  • Plug and play
  • Project modules

For more information about these strategies and how they affect upgradability, see Development strategies.

Follow development guidelines

The best way to resolve compatibility issues is to prevent them from popping up in the first place. Throughout the development cycle, we recommend following our Project development guidelines.

Follow the upgradability best practices

The Spryker Code Upgrader implements code changes on the project level.

Code changes on the project level can be delivered to a customer’s projects through manifest files. The manifest files cover a list of the ways code changes can be done.

To ensure the successful delivery of Spryker updates, we recommend using the following extension points:

In case of a project that uses a method to change code that is not covered, any expected changes will be skipped during the update process.

Bypass project upgradability issues

Learn how you can avoid and fix the project upgradability issues.