Deployment for Magento2 with

0.7.1 2017-09-19 10:35 UTC

This package is auto-updated.

Last update: 2020-12-20 18:44:32 UTC


What does it do?

This package provides deploy task for deploying Magento2 with deployer ( and additionally a tasks to synchronize database and media files.


This package depends on following packages:


  1. Install package with composer:

    composer require sourcebroker/deployer-extended-magento2

    Note! This command will install also deployer/dist package which will create ./vendor/bin/dep binary. You should use this binary to run deploy. Its advisable that you put alias dep="php ./vendor/bin/dep" in your ~/.profile to be able to run deployer with regular "dep" command.

  2. If you are using deployer as composer package then just put following line in your deploy.php:

    new \SourceBroker\DeployerExtendedMagento2\Loader();
  3. If you are using deployer as phar then put following lines in your deploy.php:

    require_once(__DIR__ . '/vendor/sourcebroker/deployer-loader/autoload.php');
    new \SourceBroker\DeployerExtendedMagento2\Loader();
  4. Remove task "deploy" from your deploy.php. Otherwise you will overwrite deploy task defined in deployer/deploy/task/deploy.php

  5. Example deploy.php file for phar based deployer:

    namespace Deployer;
    require_once(__DIR__ . '/vendor/sourcebroker/deployer-loader/autoload.php');
    new \SourceBroker\DeployerExtendedMagento2\Loader();
    set('repository', 'git@my-git:my-project.git');
    server('live', '')
        ->set('public_urls', [''])
        ->set('deploy_path', '/var/www/');
    server('beta', '')
        ->set('public_urls', [''])
        ->set('deploy_path', '/var/www/');
    server('local', 'localhost')
        ->set('public_urls', [''])
        ->set('deploy_path', getcwd());

Mind the declaration of server('local', 'localhost'); Its needed for database tasks to declare domain replacements, and path to store database dumps.

Special tasks for Magento2


If we install Magento2 with composer then we have some files in pub/ folder like '.htaccess' or 'index.php' which we sometimes want to change. Unfortunately during composer install, which is step after cloning repo, the pub/ files will be overwritten with files from vendor/magento/magento2-base.

This task allows to do checkout for for files/folders defined in param 'git_checkout_items'. So if you have changes in pub/.htaccess it will be reverted. By default the 'git_checkout_items' param has item 'pub/.htaccess'.