https://github.com/sourcebroker/deployer-extended-magento2
Deployer based deployment for Magento2 with media and database synchronisation.
https://github.com/sourcebroker/deployer-extended-magento2
deploy deployer deployer-recipes deployment magento2 sb-dem2
Last synced: 4 days ago
JSON representation
Deployer based deployment for Magento2 with media and database synchronisation.
- Host: GitHub
- URL: https://github.com/sourcebroker/deployer-extended-magento2
- Owner: sourcebroker
- License: mit
- Created: 2017-06-26T17:46:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-26T11:49:45.000Z (over 3 years ago)
- Last Synced: 2025-04-05T11:23:11.861Z (27 days ago)
- Topics: deploy, deployer, deployer-recipes, deployment, magento2, sb-dem2
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
deployer-extended-magento2
==========================
.. contents:: :local:
What does it do?
----------------
This package provides deploy task for deploying Magento2 with deployer (deployer.org) and additionally a tasks
to synchronize database and media files.
Dependencies
------------
This package depends on following packages:
- | `sourcebroker/deployer-extended`_
| Package which provides some deployer tasks that can be used for any framework or CMS.
- | `sourcebroker/deployer-extended-database`_
| Package which provides some php framework independent deployer tasks to synchronize database.
- | `sourcebroker/deployer-extended-media`_
| Package which provides some php framework independent deployer tasks to synchronize media.
Installation
------------
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:
::
hostname('111.111.111.111')
->user('www-data')
->set('public_urls', ['http://www.example.com/'])
->set('deploy_path', '/var/www/example.com.live');
host('beta')
->hostname('111.111.111.111')
->user('www-data')
->set('public_urls', ['http://beta.example.com/'])
->set('deploy_path', '/var/www/example.com.beta');
host('local')
->set('public_urls', ['http://example-com.ddev.site/'])
->set('deploy_path', getcwd());
Mind the declaration of host('local'); Its needed for database tasks to declare domain replacements,
and path to store database dumps.
Special tasks for Magento2
-------------------------
magento:deploy:git_checkout
+++++++++++++++++++++++++++
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'.
.. _sourcebroker/deployer-extended: https://github.com/sourcebroker/deployer-extended
.. _sourcebroker/deployer-extended-media: https://github.com/sourcebroker/deployer-extended-media
.. _sourcebroker/deployer-extended-database: https://github.com/sourcebroker/deployer-extended-database