Onboarding to PaaS+

Edit on GitHub

Onboarding to PaaS+ happens in two steps:

  1. Getting your project ready and compliant with a set of pre-requirements to ensure you fully benefit from all the features.
  2. Getting started with Spryker CI.

1. Get your project ready for PaaS+

Before you can start managing the upgrades of your project with PaaS+, fulfill the following prerequisites.

1.1. Update all modules to the latest version

Spryker upgrader service provides automatic minor and patch updates for the current version of each module. Since we release most of the updates for the latest versions of modules, if a module is not of the latest major version, it will not receive most of the updates.

1.2. Implement Spryker SDK in development

Using Spryker SDK for development helps you achieve compliance with Spryker architecture and customization best practices.

1.3 Make your code compliant with Spryker Quality Gate

Spryker Quality Gate contains code checkers that ensure code compliance with Srpyker development and customization guidelines. When an application is compliant with the guidelines, it can take minor and patch updates without breaking anything, even if it’s highly customized.

For instructions on making your code compliant with the guidelines, see Keeping a project upgradable.

1.4. Implement E2E testing into your project’s 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.

1.5. Migrate the codebase to GitHub or GitLab

At the moment, upgrades are provided only for repositories on GitHub or GitLab. If you want to use a different git provider, reach out to your CSM, so we can add it to our product roadmap.

1.6. Optional: Implement headless design

Currently, the quality gate does not evaluate frontend customizations. You can either move to headless or apply frontend upgrades manually.

1.7 Migrate to Spryker Cloud Commerce OS

PaaS+ supports only the projects that run on Spryker Cloud Commerce OS (SCCOS). If you are running Spryker on premises, to use PaaS+, migrate to SCCOS.

1.8 Update PHP to version 8.0

From August 2022, Spryker will stop supporting PHP 7.4. To keep receiving automatic updates after that happens, update PHP to version 8.0.

2. Onboarding to Spryker CI

Onboarding to Spryker CI consists of the following steps.

2.1 Get initial access

To get started, provide the email of your SCCOS admin. The admin user will be a super user. They will be able to change repository and invite new users to their workspace.

Once we receive the admin’s email address, we will provision and send you an email invitation to your Spryker CI workspace.

Onboarding to Spryker CI

2.2. Go to your workspace

You receive an email with a one-time invitation token, but your invitation is always active when you sign in at buddy.works. Create your account and accept the invitation to the workspace.

Spryker CI invitation

2.3. View projects inside your workspace

Your workspace contains the Spryker Upgrader Service project, as well as a project for each of your environments, like development or production.

Spryker CI projects

2.4. Connect your repositories

Connect Git repositories to your projects in Spryker CI.

2.5. Push and have fun!

Main pipeline is triggered when you push to a connected repository.

Pipelines

Support for Spryker CI