spryker-sdk/integrator

Integrator module

0.1.6 2024-11-07 12:04 UTC

README

Build Status codecov Latest Stable Version Minimum PHP Version PHPStan

Auto-migrate applications in regard to new core releases using module manifests.

Installation

This is a development only "require-dev" library:

composer require --dev spryker-sdk/integrator

Available options:

  • --format - Define the format of the command output, example: json

Available commands

module:manifest:run

Running the integrator in basic mode. Unapplied manifests will be downloaded from the repo. The command expects optional argument module-list to be set. With the argument, manifests will be applied only for modules that were specified.

integrator module:manifest:run <Organization.moduleNameA,Organization.moduleNameB (not required)>

integrator:diff:generate

Running the integrator for specific release group. Unapplied manifests will be downloaded from the S3 bucket. Result of manifest applying (git diff) will be uploaded to the same bucket. The command expects required argument release-group-id. The command expects optional argument branch-to-compare.

integrator release-group:manifest:run <release-group-id (required)> <branch-to-compare (optional)>

Please specify the next S3 credentials:

export INTEGRATOR_FILE_BUCKET_NAME=<>
export INTEGRATOR_FILE_BUCKET_CREDENTIALS_KEY=<>
export INTEGRATOR_FILE_BUCKET_CREDENTIALS_SECRET=<>
export INTEGRATOR_FILE_BUCKET_REGION=<>

Documentation

See Documentation.