The repository contains two Upgradability tools:

• Evaluator
• Upgrader ​

Evaluator

​ At this step, the upgrader checks the project against a set of rules. The main goal of this tool is to identify if the following parts of the project are compliant with the rules:

• Codebase
• Configuration
• Security
• Infrastructure ​

Evaluating projects via the SDK

​ To evaluate a project, execute the following command from its directory:

bin/console analyze:php:code-compliance --format=yaml

​

• The command generates a YAML report at {project_directory}/reports/. ​ To view a previously generated report, run the following command: ​

bin/console analyze:php:code-compliance-report

​ This command returns the content of a previously generated report. Alternatively, you can view a report via an editor. ​

Upgrader

The Upgrader tool simplifies keeping projects up-to-date with Spryker releases.

​ The Upgrader updates projects via one of the following approaches:

• Release group(default) — uses Spryker release app as data provider.
• Composer update — uses composer update command; this is the default strategy that's describes below. ​ At this step, the Upgrader updates the project to the latest version as follows:

1. Checks if the target branch has been created on the remote repository. If the branch exists, the process stops.
2. Checks if there are no uncommitted changes in the project. If there are uncommitted changes, the process stops.
3. Updates Spryker modules and dependent libraries, including third-party ones.
4. Triggers Integrator for adjust project classes.
5. Commits the changed files.
6. Pushes the changes to the remote repository.
7. Create a PR in the remote repository.

Supported strategies:

Composer strategy

• To enable Composer update strategy:

export UPGRADE_STRATEGY=composer

Release App strategy

In the strategy, Upgrader uses Spryker release app as a data provider to fetch data about Major, Minor, and Patch releases. Only Minor and Paths could be automatically applied, for now. In case when some major release is available, Upgrader put info about to PR description.

• To enable Release group strategy (default):

export UPGRADE_STRATEGY=release-app

In the strategy, Upgrader contains aggregate (default) release group requiring processor and sequential processor (one by one release group).

Sequential release group processor

• To enable Sequential release group processor:

export RELEASE_GROUP_PROCESSOR=sequential

Sequential release group processor contains threshold, by default 30 release groups for one Upgrader start.

• To change the threshold:

export THRESHOLD_RELEASE_GROUP=<number>

Aggregate release group processor

• To enable aggregate release group processor:

export RELEASE_GROUP_PROCESSOR=aggregate

Aggregate release group processor contains soft thresholds:

Soft major threshold, by default 0.

• To change soft major threshold:

export SOFT_THRESHOLD_MAJOR=<number>

Soft minor threshold, by default 10. ​

• To change soft minor threshold:

export SOFT_THRESHOLD_MINOR=<number>

​ Soft bugfix threshold, by default 30. ​

• To change soft bugfix threshold:

export SOFT_THRESHOLD_BUGFIX=<number>

Adding GitHub configuration for the update step

​ To enable the Upgrader to execute this step, apply the following configuration: ​

• GitHub is default source code provider. If you want manually define it, use the next environment variable: ​

export SOURCE_CODE_PROVIDER=github

​

• Add a GitHub access token to the project repository with the permissions to push branches and create PRs: ​

export ACCESS_TOKEN=<GITHUB_TOCKEN>

​

• Add the organization name owning the repository of the project you want to update:

export ORGANIZATION_NAME=<ORGANIZATION>

​

• Add the repository name of the project you want to update:

export REPOSITORY_NAME=<REPOSITORY>

Adding GitLab configuration for the update step

​ To enable the Upgrader to execute this step, apply the following configuration: ​

• Enable GitLab source code provider: ​

export SOURCE_CODE_PROVIDER=gitlab

​

• Add a GitLab access token to the project repository with the permissions to push branches and create PRs: ​

export ACCESS_TOKEN=<GITLAB_TOCKEN>

​

• Add the project id of the project you want to update:

export GITLAB_PROJECT_ID=<GITLAB_PROJECT_ID>

​

• Optional. For self-hosted source provider add url of your provider:

export SOURCE_CODE_PROVIDER_URL=<https://git.yourdomain.com>

​

Updating projects via the SDK

​ To update a project, run the following command from its directory:

bin/console upgradability:php:upgrade

​

Installation

​ For Spryker SDK installation instructions, see Spryker SDK