Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jalogut/magento2-deployer-plus
Tool based on deployer.org to perform zero downtime deployments of Magento 2 projects
https://github.com/jalogut/magento2-deployer-plus
Last synced: about 1 month ago
JSON representation
Tool based on deployer.org to perform zero downtime deployments of Magento 2 projects
- Host: GitHub
- URL: https://github.com/jalogut/magento2-deployer-plus
- Owner: jalogut
- License: gpl-3.0
- Created: 2018-02-23T14:30:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-03T07:37:24.000Z (about 2 years ago)
- Last Synced: 2024-11-01T00:12:10.766Z (about 1 month ago)
- Language: PHP
- Homepage:
- Size: 95.7 KB
- Stars: 200
- Watchers: 18
- Forks: 60
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-magento2 - Magento 2 Deployer Plus - Tool based on deployer.org to perform (Open Source Extensions / Deployment)
- awesome-magento2 - Magento 2 Deployer Plus - Tool based on deployer.org to perform (Open Source Extensions / Deployment)
README
# Magento 2 Deployer Plus
[](https://travis-ci.com/jalogut/magento2-deployer-plus)
* Reliable fully-automated deployments tool for Magento 2.
* Zero downtime deployments on Magento versions >= 2.2
* Automating your deployments is as easy as defining the servers where you want to deploy to.
## Motivation
This project aims to offer a common solution for fully-automated deployments on all versions of Magento 2.
This tool uses the well known [Deployer](https://deployer.org) and adds specific recipes for each Magento 2 version.
## Important Features
* [Deployer](https://deployer.org) code syntax
* Super easy setup
* Deploy to multiple servers
* Zero Downtime (only Magento >= 2.2)
* Build and Deploy artifacts (only Magento >= 2.2)
* Secure rollbacks (only Magento >= 2.2)
## Installation
```
composer require "jalogut/magento2-deployer-plus"
```
## Setup
### Magento >= 2.1
```
cp /jalogut/magento2-deployer-plus/deploy.php.sample_2_1 deploy.php
```
### Magento >= 2.2
```
cp /jalogut/magento2-deployer-plus/deploy.php.sample_2_2 deploy.php
```
### Magento >= 2.2.5
```
cp /jalogut/magento2-deployer-plus/deploy.php.sample_2_2_5 deploy.php
```
## Usage
### Git deploys:
```
/dep deploy []
```
### Build artifact deploys: (only Magento >= 2.2)
```
/dep build
/dep deploy-artifact []
```
## Disclaimer
### Build command
Build command can only be used if config propagation is properly configured. See Magento DevDocs:
* [Propagate config accross systems](http://devdocs.magento.com/guides/v2.2/config-guide/cli/config-cli-subcommands-config-mgmt-export.html)
Also check `app:config:dump` issue and workaround here:
* [PR #12410](https://github.com/magento/magento2/pull/12410)
* [Gist workaround](https://gist.github.com/jalogut/d72e0af6e10c502bff90423e66bf07b9)
## Troubleshooting
#### Js translations missing (magento versions >=2.1.3 <2.2.1)
* **Problem**: Known Magento issue when executing `setup:static-content:deploy` for several languages.
* **Github Issues**:
* [7862](https://github.com/magento/magento2/issues/7862)
* [10673](https://github.com/magento/magento2/issues/10673)
* **Solution**: Until that gets fixed in `2.2.1`, the only workaround is to execute `setup:static-content:deploy` individually for each language:
```php
// deploy.php
task('files:static_assets', '
{{bin/php}} {{magento_bin}} setup:static-content:deploy en_US {{static_deploy_options}}
{{bin/php}} {{magento_bin}} setup:static-content:deploy de_CH {{static_deploy_options}}
{{bin/php}} {{magento_bin}} setup:static-content:deploy fr_FR {{static_deploy_options}}
');
```
#### Compilation error
* **Solution**: Increase php `memory_limit` configuration to 728M o 1024M
#### Static deploy error when setting a new template (if config propagation is not used)
* **Problems**:
* `[LogicException] Unable to load theme by specified key: 'Template'`
* `@variable` is undefined in file
* **Reason**: If a new template is set, running `setup:upgrade` is required before executing `setup:static-content:deploy`
* **Solution**: Skip `setup:static-content:deploy` first time you deploy the new template:
1. Temporary disable task `files:static_assets`
```
// deploy.php
task('files:static_assets')->onRoles('Skip');
```
2. Perform a new release
3. Enable back `files:static_assets` on your `deploy.php` file
* Remove `task('files:static_assets')->onRoles('Skip');`
4. Manually execute `files:static_assets`
```
/dep files:static_assets []
```
After that, future deployments will work without issues
## Prerequisites
- PHP >= 7.0.8
- MAGENTO >= 2.1
## ChangeLog
[CHANGELOG.md](CHANGELOG.md)
## Developers
* [Juan Alonso](https://github.com/jalogut)
* [Oscar Recio](https://github.com/osrecio)
* [Contributors](https://github.com/jalogut/magento2-deployer-plus/graphs/contributors)
Licence
-------
[GNU General Public License, version 3 (GPLv3)](http://opensource.org/licenses/gpl-3.0)
Copyright
---------
(c) Juan Alonso