spryker-sdk/upgrader

Code evaluator and upgrader tool

0.3.12 2024-12-17 12:29 UTC

Requires

• php: >=8.2
• ext-json: *
• ext-simplexml: *
• composer/semver: ^3.3
• davidrjonas/composer-lock-diff: ^1.7
• ergebnis/json-printer: ^3.2
• guzzlehttp/guzzle: ^7.8
• http-interop/http-factory-guzzle: ^1.2
• knplabs/github-api: ^3.13
• m4tthumphrey/php-gitlab-api: ^11.12
• nette/neon: ^3.4
• nikic/php-parser: 5.1.*
• phpstan/phpstan: ^1.10
• spryker-sdk/azure-php-client: ^0.2.1
• spryker-sdk/integrator: ^0.1.6
• spryker-sdk/sdk-contracts: ^0.5.0
• spryker-sdk/utils: ^0.2.2
• symfony/config: ^6.0
• symfony/console: ^6.0
• symfony/dependency-injection: ^6.0
• symfony/dotenv: ^6.0
• symfony/filesystem: ^6.0
• symfony/finder: ^6.0
• symfony/framework-bundle: ^6.0
• symfony/http-kernel: ^6.0
• symfony/monolog-bundle: ^3.10
• symfony/process: ^6.0
• symfony/runtime: ^6.0
• symfony/serializer: ^6.0
• symfony/uid: ^6.0
• symfony/yaml: ^6.0

Requires (Dev)

• mikey179/vfsstream: ^1.6.11
• phpspec/prophecy-phpunit: ^2.2
• phpunit/phpunit: ^11.4.0
• spryker/code-sniffer: dev-master

proprietary

README

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

Composer update strategy

Composer install|update uses two strategies. By default Composer updates lock file with packages being downloaded.

• To enable the update of composer.lock file without packages being downloaded:

export COMPOSER_NO_INSTALL=true

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 sequential (default) release group requiring processor (one by one release group).

Sequential release group processor

• To enable Sequential release group processor (default):

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>

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 patch threshold:

export SOFT_THRESHOLD_PATCH=<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_TOKEN>

​

• 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_TOKEN>

​

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

export PROJECT_ID=<PROJECT_ID>

​

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

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

Adding Azure configuration for the update step

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

• Enable Azure source code provider: ​

export SOURCE_CODE_PROVIDER=azure

​

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

export ACCESS_TOKEN=<AZURE_TOKEN>

​

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

export ORGANIZATION_NAME=<ORGANIZATION_NAME>

​

• Add a project name or project id you want to update: ​

export PROJECT_NAME=<PROJECT_NAME>
# OR
export PROJECT_ID=<PROJECT_ID>

​

• Add a project's repository name or repository id: ​

export REPOSITORY_NAME=<REPOSITORY_NAME>
# OR
export REPOSITORY_ID=<REPOSITORY_ID>

​

Reporting configuration

​

• Optional. Defines execution environment for report statistics:

export APP_ENV=sprykerci

​

• Optional. Enable the report sending functionality. it’s disabled by default.

export REPORTING_ENABLED=true

​

• Optional. Secure token for remote server request authorization in report sending process.

export REPORT_SEND_AUTH_TOKEN=<TOKEN>

​

Updating projects via the SDK

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

bin/console upgradability:php:upgrade

Enable release group integrator

​

• Turn on the specific behavior for the release group integrator (for internal usage).

export RELEASE_GROUP_INTEGRATOR_ENABLED=true

Enable minimal updates of third-party dependencies

​

• Turn on specific behavior to minimize update 3rd-party dependencies.

export UPDATE_MINIMUM_DEPENDENCIES_ENABLED=true

Enable update features to dev-master fixer

​

• Turn on internal specific behavior to update features to dev-master.

export UPDATE_FEATURES_TO_DEV_MASTER=true

Enable project change integration

​

• Turn on integrator trigger after package update step

export INTEGRATOR_ENABLED=true

Disable installing new Spryker packages

​

• Turn off installing new Spryker packages

export PACKAGE_UPGRADE_ONLY=true

Enable project code compliance after update

​

• Turn on code compliance trigger after package update step

export EVALUATOR_ENABLED=true

Specify release group

​

• Specify release group to apply only it packages

export RELEASE_GROUP_ID=123

Specify the pull request reviewers

​

• Specify the GitHub user login to add as reviewers to the pull request

export PULL_REQUEST_REVIEWERS=<login_1,login_two,...>

Installation

​ For Spryker SDK installation instructions, see Spryker SDK