README

This package provides a functionality for Spryker to execute one-time tasks after a deployment based on the environment and store.

Installation
Usage
Configuration
Credits
License

Installation

composer require [--dev] turbine-kreuzberg/spryker-deploy-tasks

Setup

To use the provided console commands you will need to register the namespace TurbineKreuzberg in config/Shared/config_default.php.

$config[KernelConstants::CORE_NAMESPACES] = [
    // add 'TurbineKreuzberg' as a core namespace
    'TurbineKreuzberg',
];

In src/Pyz/Zed/Console/ConsoleDependencyProvider.php you need to register the console command plugin for deploy tasks.

use TurbineKreuzberg\Zed\DeployTasks\Communication\Console\DeployTasksCreateConsole;
use TurbineKreuzberg\Zed\DeployTasks\Communication\Console\DeployTasksExecuteConsole;

    protected function getConsoleCommands(Container $container): array
    {
        $commands = [
            // other registered console plugins ...

            new DeployTasksCreateConsole(),
            new DeployTasksExecuteConsole(),
        ];

Then you should see a new section deploy in the console command list:

 deploy
  deploy:tasks:create   Generate new yml file for deploy tasks
  deploy:tasks:execute  Execute all deploy tasks

Usage

Create new deploy task file

vendor/bin/console deploy:tasks:create

This will create a new YAML file with an auto-generated name containing the current timestamp (e.g. tasks.1697540350.yml) and this content:

tasks:
# add new deploy tasks as an array to this file

# a task has to be an item with the mandatory keys 'command', 'execute_for_store' and 'execute_on'
# - the value for 'command' should be an executable shell command line (multiple commands and options possible)
# - the entries for 'execute_for_store' have to match the value of env var APPLICATION_STORE
# - the entries for 'execute_on' have to match the value of env var SHOP_ENV (dev,int,stage,prd)
- command: "some/command/to/execute --with-option --another-option-with-value foo && some/other/command"
  execute_for_store:
  - DE
  - EN
  execute_on:
  - dev
  - int
  - stage
  - prd
# to skip executing a task in a particular environment, it needs to be
# removed from the 'execute_on' list
- command: "some/other/command/to/execute/everywhere/but/production"
  execute_for_store:
  - DE
  - EN
  execute_on:
  - dev
  - int
  - stage
# to skip executing a task in a particular store, it needs to be
# removed from the 'execute_for_store' list
- command: "some/other/command/to/execute/everywhere/only/for/store-en"
  execute_for_store:
  - EN
  execute_on:
  - dev
  - int
  - stage
  - prd
# task can have additional optional keys, e.g. 'description'
- command: "yet/another/command/to/execute"
  description: "description for yet another command to execute"
  execute_for_store:
  - DE
  - EN
  execute_on:
  - dev
  - int
  - stage
  - prd

You have to define explicitly for which stores and environments the task should be executed.
There is no 'all environments' or 'all stores' option. This should prevent accidental execution of tasks in environments or stores where they should not be executed.

Execute deploy tasks

vendor/bin/console deploy:tasks:execute

This command will execute deploy tasks from all YAML files that have not been executed for the current environment and store yet. Executed tasks will be logged in a new table txb_deploy_tasks in the database. The mechanism is very much the same as for Propel migrations.

Credits

All Contributors

License

The MIT License (MIT). Please see License File for more information.

turbine-kreuzberg / spryker-deploy-tasks

Maintainers

Details