├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE.txt ├── README.md ├── autoload.php ├── composer.json ├── config └── artifact.excludes ├── deploy.php.sample_2_1 ├── deploy.php.sample_2_2 ├── deploy.php.sample_2_2_5 ├── grumphp.yml ├── phpcs.xml ├── phpmd.xml └── recipe ├── magento_2_1.php ├── magento_2_1 ├── cache.php ├── database.php ├── files.php ├── maintenance.php ├── override_shared.php └── rollback.php ├── magento_2_2.php ├── magento_2_2 ├── artifact.php ├── config.php ├── crontab.php ├── database.php ├── files.php ├── maintenance.php └── rollback.php ├── magento_2_2_5.php ├── magento_2_2_5 └── config.php └── magento_2_2_x └── crontab.php /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .DS_STORE 3 | vendor/ -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: php 2 | 3 | php: 4 | - 7.0 5 | - 7.1 6 | - 7.2 7 | 8 | before_install: 9 | - sudo apt-get -qq update 10 | 11 | install: 12 | - composer self-update 13 | - composer install 14 | 15 | script: 16 | - vendor/bin/grumphp run 17 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) 5 | and this project adheres to [Semantic Version](http://semver.org/spec/v2.0.0.html). 6 | 7 | ## [Unreleased] 8 | ### Added 9 | 10 | ### Changed 11 | 12 | ### Removed 13 | 14 | ## [2.7.1] - 16-04-2020 15 | ### Changed 16 | * fix task `files:permissions` to change to `magento_dir` folder before set permissions 17 | 18 | ## [2.7.0] - 05-12-2019 19 | ### Added 20 | * task `cache:enable` to enable modules during deployment 21 | 22 | ### Changed 23 | * Fixes wrong permissions after extracting archive 24 | 25 | ## [2.6.0] - 05-12-2019 26 | ### Changed 27 | * fix Grumphp Tests 28 | 29 | ## [2.5.0] - 13-03-2019 30 | ### Added 31 | * task `files:remove-generated` to delete generated folder content 32 | 33 | ## [2.4.0] - 25-02-2019 34 | ### Changed 35 | * `database:upgrade` to split `schema:upgrade` and `data:upgrade` 36 | 37 | ## [2.3.0] - 18-12-2018 38 | ### Changed 39 | 40 | * `files:permissions` task now runs faster and is more concise. 41 | 42 | ## [2.2.2] - 19-10-2018 43 | ### Changed 44 | 45 | * Fix `config:remove-dev-modules` step was executed local instead of remote 46 | 47 | ## [2.2.1] - 05-09-2018 48 | ### Added 49 | 50 | * Exclude test stub modules during artifact generation. Magento creates automatically these modules during integration 51 | tests. If these modules happen to end up in your production server, the checkout gets broken. 52 | 53 | * https://github.com/magento/magento2/issues/12696 54 | * https://github.com/magento/magento2/issues/12679 55 | 56 | ## [2.2] - 24-07-2018 57 | ### Added 58 | * Task `config:remove-dev-modules` that removes modules specified in `dev_modules` from `app/etc/config.php` during deployment. 59 | Modules installed with composer `require-dev` that are present in `app/etc/config.php` must be added here to prevent problems with `bin/magento setup:db:status` 60 | 61 | ## [2.1] - 05-07-2018 62 | ### Added 63 | * Task `deploy:override_shared` to replace dirs and create symlinks taking the dir from new release as source 64 | * This is needed for caches. They cannot be symlinked during the files generation but they need to replace previous 65 | ones and be shared among servers in multi-server setups. 66 | * New params `override_shared_dirs` and `override_shared_files` 67 | 68 | ### Changed 69 | * Cache dirs are moved from `shared_dirs` to `override_shared_dirs` 70 | 71 | ### Removed 72 | * Default values for `writable_dirs` and `clean_paths` have been removed. They are no longer needed as the dir 73 | permissions are set with `files:permissions` tasks and the `static/_cache` is overwritten with `override_shared_dirs` 74 | * Task `crontab:update` removed because it appends new cronjobs with every release. We'll fix it in a future release 75 | 76 | ## [2.0.1] - 03-07-2018 77 | ### Changed 78 | * Update require recipe path on sample files. Now the whole relative path to vendor dir is needed. 79 | 80 | ## [2.0] - 29-06-2018 81 | ### Added 82 | * `var` subdirectories added to `shared_dirs`. 83 | * `/var/log` 84 | * `/var/backups` 85 | * `/var/cache` 86 | * `/var/page_cache` 87 | * `/var/session` 88 | * `maintenance:unset` during rollback 89 | * Use `app:config:status` command on Magento versions `>=2.2.5` 90 | 91 | ### Changed 92 | * Use `deployer/dist` instead of `deployer/deployer` to avoid conflicts with composer dependencies. 93 | 94 | ### Removed 95 | * remove `var` dir from `shared_dirs` because `generated` and `view_preprocessed` should not be shared among releases. If not, we are changing the current generated code while building the new release. 96 | 97 | ## [1.1.1] - 04-04-2018 98 | ### Added 99 | * Execute `setup:upgrade` and `app:config:import` in no interaction mode 100 | 101 | ## [1.1] - 04-04-2018 102 | ### Removed 103 | * Remove `writable_dirs` param because permissions are already set on `files:permissions` task 104 | * Remove `ci_branch` param as it is not used 105 | 106 | ## [1.0.7] - 04-04-2018 107 | ### Removed 108 | * Sample configuration of `maintenance` and `cache` tasks only executed for master server. These tasks should be executed on all servers unless the `var` folder is shared among server instances 109 | 110 | ## [1.0.6] - 02-04-2018 111 | ### Changed 112 | * Fix `cache:clear` command call on `rollback` task 113 | 114 | ## [1.0.5] - 01-04-2018 115 | ### Added 116 | * Add `cache:clear:if-maintenance` to flush all caches after maintenance is set 117 | * Add timestamp for `release_name` in sample files 118 | 119 | ## [1.0.4] - 27-03-2018 120 | ### Added 121 | * `maintenance:unset` after switching symlink 122 | 123 | ### Removed 124 | * Remove not needed `maintenance:unset` during rollback 125 | 126 | ## [1.0.3] - 27-03-2018 127 | ### Changed 128 | * Fix `crontab:update` execute only if current path exists 129 | * Fix `cache:clear` properly call task using `invoke()` 130 | * Task destroy artefact after extraction 131 | 132 | ## [1.0.2] - 21-03-2018 133 | ### Changed 134 | * Fix exclude `var/cache` and `var/page_cache` from artifact. Excluding `cache` was also excluding some module cache folders that are needed. 135 | 136 | ## [1.0.1] - 20-03-2018 137 | ### Changed 138 | * Fix `crontab:update` step due to changes introduced on version 2.2.2 139 | * [https://github.com/magento/magento2/commit/79e9054aa2fd66a6c804774617cd0f5d14ffc49a](https://github.com/magento/magento2/commit/79e9054aa2fd66a6c804774617cd0f5d14ffc49a) 140 | 141 | ## [1.0] - 05-03-2018 142 | ### Added 143 | * Use deployers `{{bin/php}}` with every execution of `{{magento_bin}}` 144 | 145 | ## [0.2] - 26-01-2018 146 | ### Added 147 | * Task `cache:clear:magento` 148 | 149 | ### Changed 150 | * Add `var` dir in `shared_dirs`. It makes more sense for multi-servers setup to have `var` dir shared among servers. 151 | * Change task name `clear:cache` to `cache:clear` 152 | 153 | ### Removed 154 | * Remove `var/.ip.maintenance` and `var/backups from shared configuration 155 | 156 | ## [0.1] - 25-01-2018 157 | * First working version 158 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Magento 2 Deployer Plus 2 | 3 | [![Build Status](https://travis-ci.com/jalogut/magento2-deployer-plus.svg?branch=develop)](https://travis-ci.com/jalogut/magento2-deployer-plus) 4 | 5 | * Reliable fully-automated deployments tool for Magento 2. 6 | * Zero downtime deployments on Magento versions >= 2.2 7 | * Automating your deployments is as easy as defining the servers where you want to deploy to. 8 | 9 | ## Motivation 10 | 11 | This project aims to offer a common solution for fully-automated deployments on all versions of Magento 2. 12 | This tool uses the well known [Deployer](https://deployer.org) and adds specific recipes for each Magento 2 version. 13 | 14 | ## Important Features 15 | 16 | * [Deployer](https://deployer.org) code syntax 17 | * Super easy setup 18 | * Deploy to multiple servers 19 | * Zero Downtime (only Magento >= 2.2) 20 | * Build and Deploy artifacts (only Magento >= 2.2) 21 | * Secure rollbacks (only Magento >= 2.2) 22 | 23 | ## Installation 24 | 25 | ``` 26 | composer require "jalogut/magento2-deployer-plus" 27 | ``` 28 | 29 | ## Setup 30 | 31 | ### Magento >= 2.1 32 | 33 | ``` 34 | cp /jalogut/magento2-deployer-plus/deploy.php.sample_2_1 deploy.php 35 | ``` 36 | 37 | ### Magento >= 2.2 38 | 39 | ``` 40 | cp /jalogut/magento2-deployer-plus/deploy.php.sample_2_2 deploy.php 41 | ``` 42 | 43 | ### Magento >= 2.2.5 44 | 45 | ``` 46 | cp /jalogut/magento2-deployer-plus/deploy.php.sample_2_2_5 deploy.php 47 | ``` 48 | 49 | ## Usage 50 | 51 | ### Git deploys: 52 | 53 | ``` 54 | /dep deploy [] 55 | ``` 56 | 57 | ### Build artifact deploys: (only Magento >= 2.2) 58 | 59 | ``` 60 | /dep build 61 | /dep deploy-artifact [] 62 | ``` 63 | 64 | ## Disclaimer 65 | 66 | ### Build command 67 | Build command can only be used if config propagation is properly configured. See Magento DevDocs: 68 | 69 | * [Propagate config accross systems](http://devdocs.magento.com/guides/v2.2/config-guide/cli/config-cli-subcommands-config-mgmt-export.html) 70 | 71 | Also check `app:config:dump` issue and workaround here: 72 | 73 | * [PR #12410](https://github.com/magento/magento2/pull/12410) 74 | * [Gist workaround](https://gist.github.com/jalogut/d72e0af6e10c502bff90423e66bf07b9) 75 | 76 | ## Troubleshooting 77 | 78 | #### Js translations missing (magento versions >=2.1.3 <2.2.1) 79 | 80 | * **Problem**: Known Magento issue when executing `setup:static-content:deploy` for several languages. 81 | 82 | * **Github Issues**: 83 | * [7862](https://github.com/magento/magento2/issues/7862) 84 | * [10673](https://github.com/magento/magento2/issues/10673) 85 | 86 | * **Solution**: Until that gets fixed in `2.2.1`, the only workaround is to execute `setup:static-content:deploy` individually for each language: 87 | 88 | ```php 89 | // deploy.php 90 | task('files:static_assets', ' 91 | {{bin/php}} {{magento_bin}} setup:static-content:deploy en_US {{static_deploy_options}} 92 | {{bin/php}} {{magento_bin}} setup:static-content:deploy de_CH {{static_deploy_options}} 93 | {{bin/php}} {{magento_bin}} setup:static-content:deploy fr_FR {{static_deploy_options}} 94 | '); 95 | ``` 96 | 97 | #### Compilation error 98 | 99 | * **Solution**: Increase php `memory_limit` configuration to 728M o 1024M 100 | 101 | #### Static deploy error when setting a new template (if config propagation is not used) 102 | 103 | * **Problems**: 104 | * `[LogicException] Unable to load theme by specified key: 'Template'` 105 | * `@variable` is undefined in file 106 | * **Reason**: If a new template is set, running `setup:upgrade` is required before executing `setup:static-content:deploy` 107 | * **Solution**: Skip `setup:static-content:deploy` first time you deploy the new template: 108 | 109 | 1. Temporary disable task `files:static_assets` 110 | 111 | ``` 112 | // deploy.php 113 | task('files:static_assets')->onRoles('Skip'); 114 | ``` 115 | 116 | 2. Perform a new release 117 | 3. Enable back `files:static_assets` on your `deploy.php` file 118 | 119 | * Remove `task('files:static_assets')->onRoles('Skip');` 120 | 121 | 4. Manually execute `files:static_assets` 122 | 123 | ``` 124 | /dep files:static_assets [] 125 | ``` 126 | 127 | After that, future deployments will work without issues 128 | 129 | ## Prerequisites 130 | 131 | - PHP >= 7.0.8 132 | - MAGENTO >= 2.1 133 | 134 | ## ChangeLog 135 | 136 | [CHANGELOG.md](CHANGELOG.md) 137 | 138 | ## Developers 139 | 140 | * [Juan Alonso](https://github.com/jalogut) 141 | * [Oscar Recio](https://github.com/osrecio) 142 | * [Contributors](https://github.com/jalogut/magento2-deployer-plus/graphs/contributors) 143 | 144 | Licence 145 | ------- 146 | [GNU General Public License, version 3 (GPLv3)](http://opensource.org/licenses/gpl-3.0) 147 | 148 | Copyright 149 | --------- 150 | (c) Juan Alonso 151 | -------------------------------------------------------------------------------- /autoload.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | set_include_path(get_include_path() . PATH_SEPARATOR . __DIR__); 12 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "jalogut/magento2-deployer-plus", 3 | "description": "Magento 2 deployment tool based on deployer.org", 4 | "keywords": ["magento2", "deployment", "deployer", "deploy", "tool"], 5 | "license": [ 6 | "GPL-3.0" 7 | ], 8 | "authors": [ 9 | { 10 | "name": "Juan Alonso", 11 | "email": "juan.jalogut@gmail.com" 12 | } 13 | ], 14 | "require": { 15 | "deployer/dist": "^6.0" 16 | }, 17 | "require-dev": { 18 | "phpro/grumphp": "^0.14.0", 19 | "phpmd/phpmd": "^2.6", 20 | "nikic/php-parser": "^3.1", 21 | "squizlabs/php_codesniffer": "^3.2", 22 | "phpstan/phpstan": "^0.9.2", 23 | "friendsofphp/php-cs-fixer": "^2.11" 24 | }, 25 | "autoload": { 26 | "files": [ 27 | "autoload.php" 28 | ] 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /config/artifact.excludes: -------------------------------------------------------------------------------- 1 | var/cache 2 | var/page_cache 3 | _cache 4 | pub/media 5 | env.php 6 | tests 7 | Test 8 | Tests 9 | var/log 10 | logs 11 | .git 12 | .gitattributes 13 | .gitignore 14 | .gitmodules 15 | 16 | # Magento test stub modules 17 | app/code/Magento/Test* 18 | 19 | # deployer files 20 | bin/dep 21 | deploy.php 22 | artifacts 23 | -------------------------------------------------------------------------------- /deploy.php.sample_2_1: -------------------------------------------------------------------------------- 1 | hostname('') 28 | ->user('') 29 | ->set('deploy_path', '~') 30 | ->stage('dev') 31 | ->roles('master'); 32 | 33 | host('stage_master') 34 | ->hostname('') 35 | ->user('') 36 | ->set('deploy_path', '~') 37 | ->stage('stage') 38 | ->roles('master'); 39 | 40 | host('prod_master') 41 | ->hostname('') 42 | ->user('') 43 | ->set('deploy_path', '~') 44 | ->stage('prod') 45 | ->roles('master'); 46 | 47 | // ---- Multi-server Configuration ---- 48 | // Tasks available only for specific roles 49 | // task('database:upgrade')->onRoles('master'); 50 | // 51 | //host('prod_slave_1') 52 | // ->hostname('') 53 | // ->user('') 54 | // ->set('deploy_path', '~') 55 | // ->stage('prod') 56 | // ->roles('slave'); 57 | // 58 | //host('prod_slave_2') 59 | // ->hostname('') 60 | // ->user('') 61 | // ->set('deploy_path', '~') 62 | // ->stage('prod') 63 | // ->roles('slave'); 64 | -------------------------------------------------------------------------------- /deploy.php.sample_2_2: -------------------------------------------------------------------------------- 1 | hostname('') 31 | ->user('') 32 | ->set('deploy_path', '~') 33 | ->stage('dev') 34 | ->roles('master'); 35 | 36 | host('stage_master') 37 | ->hostname('') 38 | ->user('') 39 | ->set('deploy_path', '~') 40 | ->stage('stage') 41 | ->roles('master'); 42 | 43 | host('prod_master') 44 | ->hostname('') 45 | ->user('') 46 | ->set('deploy_path', '~') 47 | ->stage('prod') 48 | ->roles('master'); 49 | 50 | // ---- Multi-server Configuration ---- 51 | // Tasks available only for specific roles 52 | // task('config:import')->onRoles('master'); 53 | // task('database:upgrade')->onRoles('master'); 54 | // task('crontab:update')->onRoles('master'); 55 | // 56 | //host('prod_slave_1') 57 | // ->hostname('') 58 | // ->user('') 59 | // ->set('deploy_path', '~') 60 | // ->stage('prod') 61 | // ->roles('slave'); 62 | // 63 | //host('prod_slave_2') 64 | // ->hostname('') 65 | // ->user('') 66 | // ->set('deploy_path', '~') 67 | // ->stage('prod') 68 | // ->roles('slave'); 69 | -------------------------------------------------------------------------------- /deploy.php.sample_2_2_5: -------------------------------------------------------------------------------- 1 | hostname('') 31 | ->user('') 32 | ->set('deploy_path', '~') 33 | ->stage('dev') 34 | ->roles('master'); 35 | 36 | host('stage_master') 37 | ->hostname('') 38 | ->user('') 39 | ->set('deploy_path', '~') 40 | ->stage('stage') 41 | ->roles('master'); 42 | 43 | host('prod_master') 44 | ->hostname('') 45 | ->user('') 46 | ->set('deploy_path', '~') 47 | ->stage('prod') 48 | ->roles('master'); 49 | 50 | // ---- Multi-server Configuration ---- 51 | // Tasks available only for specific roles 52 | // task('config:import')->onRoles('master'); 53 | // task('database:upgrade')->onRoles('master'); 54 | // task('crontab:update')->onRoles('master'); 55 | // 56 | //host('prod_slave_1') 57 | // ->hostname('') 58 | // ->user('') 59 | // ->set('deploy_path', '~') 60 | // ->stage('prod') 61 | // ->roles('slave'); 62 | // 63 | //host('prod_slave_2') 64 | // ->hostname('') 65 | // ->user('') 66 | // ->set('deploy_path', '~') 67 | // ->stage('prod') 68 | // ->roles('slave'); 69 | -------------------------------------------------------------------------------- /grumphp.yml: -------------------------------------------------------------------------------- 1 | parameters: 2 | bin_dir: ./vendor/bin 3 | git_dir: . 4 | stop_on_failure: false 5 | hide_circumvention_tip: true 6 | ascii: 7 | failed: ~ 8 | succeeded: ~ 9 | composer: 10 | file: ./composer.json 11 | no_check_all: true 12 | no_check_lock: false 13 | no_check_publish: false 14 | with_dependencies: false 15 | strict: false 16 | git_blacklist: 17 | keywords: 18 | - "die(" 19 | - "var_dump(" 20 | - "exit;" 21 | - "console.log(" 22 | triggered_by: ['php'] 23 | regexp_type: G 24 | tasks: 25 | phpmd: 26 | ruleset: ['phpmd.xml'] 27 | phpcs: 28 | standard: 'phpcs.xml' 29 | extensions: [] -------------------------------------------------------------------------------- /phpcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Magento 2 Deployer Plus Coding Standards 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | vendor/autoload.php 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /phpmd.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /recipe/magento_2_1.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | require_once 'recipe/common.php'; 14 | require_once __DIR__ . '/magento_2_1/files.php'; 15 | require_once __DIR__ . '/magento_2_1/maintenance.php'; 16 | require_once __DIR__ . '/magento_2_1/database.php'; 17 | require_once __DIR__ . '/magento_2_1/cache.php'; 18 | require_once __DIR__ . '/magento_2_1/rollback.php'; 19 | require_once __DIR__ . '/magento_2_1/override_shared.php'; 20 | 21 | # ----- Deployment properties --- 22 | set('default_timeout', 900); 23 | // [Optional] git repository 24 | set('repository', ''); 25 | // [Optional] Allocate tty for git clone. Default value is false. 26 | set('git_tty', true); 27 | 28 | // Remove Composer autoloader optimization; it needs to be done separately after 29 | // Magento's DI compilation so that the generated classes are part of Composer's 30 | // classmap. 31 | set( 32 | 'composer_options', 33 | str_replace(' --optimize-autoloader', '', get('composer_options')) 34 | ); 35 | 36 | # ----- Magento properties ------- 37 | set('magento_dir', 'magento'); 38 | set('magento_bin', '{{magento_dir}}/bin/magento'); 39 | 40 | set('shared_files', [ 41 | '{{magento_dir}}/app/etc/env.php', 42 | ]); 43 | 44 | set('shared_dirs', [ 45 | '{{magento_dir}}/pub/media', 46 | '{{magento_dir}}/var/log', 47 | '{{magento_dir}}/var/backups', 48 | '{{magento_dir}}/var/session', 49 | '{{magento_dir}}/var/report', 50 | '{{magento_dir}}/var/import', 51 | '{{magento_dir}}/var/export', 52 | ]); 53 | 54 | set('override_shared_dirs', [ 55 | '{{magento_dir}}/var/cache', 56 | '{{magento_dir}}/var/page_cache', 57 | '{{magento_dir}}/pub/static/_cache', 58 | ]); 59 | 60 | # ---- Deployment Flow 61 | desc('Deploy project'); 62 | task('deploy', [ 63 | 'deploy:info', 64 | 'deploy:prepare', 65 | 'deploy:lock', 66 | 'deploy:release', 67 | 'deploy:update_code', 68 | 'deploy:vendors', 69 | 'deploy:clear_paths', 70 | 'deploy:shared', 71 | 'deploy:writable', 72 | 'files:generate', 73 | 'maintenance:set', 74 | 'cache:clear:if-maintenance', 75 | 'database:upgrade', 76 | 'deploy:override_shared', 77 | 'deploy:symlink', 78 | 'maintenance:unset', 79 | 'cache:clear', 80 | 'deploy:unlock', 81 | 'cleanup', 82 | 'success', 83 | ]); 84 | 85 | after('deploy:failed', 'deploy:unlock'); 86 | 87 | before('rollback', 'rollback:validate'); 88 | after('rollback', 'maintenance:unset'); 89 | after('rollback', 'cache:clear'); 90 | -------------------------------------------------------------------------------- /recipe/magento_2_1/cache.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | task('cache:clear:magento', '{{bin/php}} {{magento_bin}} cache:flush'); 14 | 15 | task('cache:clear', function () { 16 | invoke('cache:clear:magento'); 17 | }); 18 | 19 | task('cache:clear:if-maintenance', function () { 20 | test('[ -f {{deploy_path}}/current/{{magento_dir}}/var/.maintenance.flag ]') ? 21 | invoke('cache:clear:magento') : 22 | writeln('Skipped -> maintenance is not set'); 23 | }); 24 | 25 | /* 26 | * By default, cache enabling is disabled. 27 | */ 28 | set('cache_enabled_caches', ''); 29 | 30 | /* 31 | * To enable all caches after deployment, configure the following: 32 | */ 33 | //set('cache_enabled_caches', 'all'); 34 | 35 | 36 | /* 37 | * One can provide specific caches as well. 38 | */ 39 | /*set('cache_enabled_caches', 40 | [ 41 | 'config', 42 | 'layout', 43 | 'block_html', 44 | 'collections', 45 | 'reflection', 46 | 'db_ddl', 47 | 'eav', 48 | 'customer_notification', 49 | 'full_page', 50 | 'config_integration', 51 | 'config_integration_api', 52 | 'translate', 53 | 'config_webservice', 54 | 'compiled_config', 55 | ] 56 | ); 57 | */ 58 | 59 | task('cache:enable', function () { 60 | $enabledCaches = get('cache_enabled_caches'); 61 | 62 | if (empty($enabledCaches)) { 63 | return; 64 | } 65 | 66 | $command = '{{bin/php}} {{release_path}}/{{magento_bin}} cache:enable'; 67 | 68 | if ($enabledCaches === 'all') { 69 | run($command); 70 | } 71 | 72 | if (is_array($enabledCaches)) { 73 | run($command . ' ' . implode(' ', $enabledCaches)); 74 | } 75 | }); 76 | -------------------------------------------------------------------------------- /recipe/magento_2_1/database.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | task('database:upgrade', function () { 14 | run('{{bin/php}} {{release_path}}/{{magento_bin}} setup:db-schema:upgrade --no-interaction'); 15 | run('{{bin/php}} {{release_path}}/{{magento_bin}} setup:db-data:upgrade --no-interaction'); 16 | }); 17 | -------------------------------------------------------------------------------- /recipe/magento_2_1/files.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | set('languages', 'en_US'); 14 | set('static_deploy_options', '--exclude-theme=Magento/blank'); 15 | 16 | task('files:compile', '{{bin/php}} {{magento_bin}} setup:di:compile'); 17 | task('files:optimize-autoloader', '{{bin/composer}} dump-autoload --no-dev --optimize --apcu'); 18 | task('files:static_assets', '{{bin/php}} {{magento_bin}} setup:static-content:deploy {{languages}} {{static_deploy_options}}'); 19 | task( 20 | 'files:permissions', 21 | 'cd {{magento_dir}} && chmod -R g+w var vendor pub/static pub/media app/etc && chmod u+x bin/magento' 22 | ); 23 | 24 | desc('Generate Magento Files'); 25 | task('files:generate', [ 26 | 'files:compile', 27 | 'files:optimize-autoloader', 28 | 'files:static_assets', 29 | 'files:permissions', 30 | ]); 31 | -------------------------------------------------------------------------------- /recipe/magento_2_1/maintenance.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | task('maintenance:set', function () { 14 | # IMPORTANT: do not use {{current_path}} for the "-f" check. 15 | # {{current_path}} returns error if symlink does not exists 16 | test('[ -f {{deploy_path}}/current/{{magento_bin}} ]') ? 17 | run('{{bin/php}} {{current_path}}/{{magento_bin}} maintenance:enable') : 18 | writeln('Skipped -> current not found'); 19 | }); 20 | 21 | task('maintenance:unset', function () { 22 | # IMPORTANT: do not use {{current_path}} for the "-f" check. 23 | # {{current_path}} returns error if symlink does not exists 24 | if (!test('[ -f {{deploy_path}}/current/{{magento_bin}} ]')) { 25 | writeln('Skipped -> current not found'); 26 | return; 27 | } 28 | test('[ -f {{deploy_path}}/current/{{magento_dir}}/var/.maintenance.flag ]') ? 29 | run('{{bin/php}} {{current_path}}/{{magento_bin}} maintenance:disable') : 30 | writeln('Skipped -> maintenance is already unset'); 31 | }); 32 | -------------------------------------------------------------------------------- /recipe/magento_2_1/override_shared.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | use Deployer\Exception\Exception; 14 | 15 | set('override_shared_dirs', []); 16 | set('override_shared_files', []); 17 | 18 | desc('Creating Override symlinks for override shared files and dirs'); 19 | task('deploy:override_shared', function () { 20 | $sharedPath = "{{deploy_path}}/shared"; 21 | 22 | // Validate shared_dir, find duplicates 23 | foreach (get('override_shared_dirs') as $a) { 24 | foreach (get('override_shared_dirs') as $b) { 25 | if ($a !== $b && strpos(rtrim($a, '/') . '/', rtrim($b, '/') . '/') === 0) { 26 | throw new Exception("Can not share same dirs `$a` and `$b`."); 27 | } 28 | } 29 | } 30 | 31 | foreach (get('override_shared_dirs') as $dir) { 32 | // Check if shared dir exists. 33 | if (test("[ -d $sharedPath/$dir ]")) { 34 | // remove shared dir 35 | run("rm -rf $sharedPath/$dir"); 36 | } 37 | // If release contains shared dir, copy that dir from release to shared. 38 | if (test("[ -d $(echo {{release_path}}/$dir) ]")) { 39 | run("cp -rv {{release_path}}/$dir $sharedPath/" . dirname(parse($dir))); 40 | run("rm -rf {{release_path}}/$dir"); 41 | } else { 42 | // Create shared dir if it does not exist. 43 | run("mkdir -p $sharedPath/$dir"); 44 | } 45 | 46 | // Create path to shared dir in release dir if it does not exist. 47 | // Symlink will not create the path and will fail otherwise. 48 | run("mkdir -p `dirname {{release_path}}/$dir`"); 49 | 50 | // Symlink shared dir to release dir 51 | run("{{bin/symlink}} $sharedPath/$dir {{release_path}}/$dir"); 52 | } 53 | 54 | foreach (get('override_shared_files') as $file) { 55 | $dirname = dirname(parse($file)); 56 | 57 | // Create dir of shared file 58 | run("mkdir -p $sharedPath/" . $dirname); 59 | 60 | // Check if shared file exists in shared and remove it 61 | if (test("[ -f $sharedPath/$file ]")) { 62 | run("rm -rf $sharedPath/$file"); 63 | } 64 | 65 | // If file exist in release 66 | if (test("[ -f {{release_path}}/$file ]")) { 67 | // Copy file in shared dir if not present 68 | run("cp -rv {{release_path}}/$file $sharedPath/$file"); 69 | run("rm -rf {{release_path}}/$file"); 70 | } 71 | 72 | // Ensure dir is available in release 73 | run("if [ ! -d $(echo {{release_path}}/$dirname) ]; then mkdir -p {{release_path}}/$dirname;fi"); 74 | 75 | // Touch shared 76 | run("touch $sharedPath/$file"); 77 | 78 | // Symlink shared dir to release dir 79 | run("{{bin/symlink}} $sharedPath/$file {{release_path}}/$file"); 80 | } 81 | }); 82 | -------------------------------------------------------------------------------- /recipe/magento_2_1/rollback.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | use Deployer\Exception\Exception; 14 | 15 | task('rollback:validate', function () { 16 | $errorMessage = 'Secure rollback not possible' . PHP_EOL; 17 | $errorMessage .= PHP_EOL; 18 | $errorMessage .= 'This Magento version has the following constraints:' . PHP_EOL; 19 | $errorMessage .= '- Not possible to know if previous release is compatible with current DB schema' . PHP_EOL; 20 | $errorMessage .= PHP_EOL; 21 | $errorMessage .= 'You can still do a manual rollback at your own risk' . PHP_EOL; 22 | throw new Exception($errorMessage); 23 | }); 24 | -------------------------------------------------------------------------------- /recipe/magento_2_2.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | require_once 'recipe/common.php'; 14 | require_once __DIR__ . '/magento_2_1.php'; 15 | require_once __DIR__ . '/magento_2_2/artifact.php'; 16 | require_once __DIR__ . '/magento_2_2/maintenance.php'; 17 | require_once __DIR__ . '/magento_2_2/database.php'; 18 | require_once __DIR__ . '/magento_2_2/config.php'; 19 | require_once __DIR__ . '/magento_2_2/crontab.php'; 20 | require_once __DIR__ . '/magento_2_2/files.php'; 21 | require_once __DIR__ . '/magento_2_2/rollback.php'; 22 | 23 | desc('Build Artifact'); 24 | task('build', function () { 25 | set('deploy_path', '.'); 26 | set('release_path', '.'); 27 | set('current_path', '.'); 28 | $origStaticOptions = get('static_deploy_options'); 29 | set('static_deploy_options', '-f ' . $origStaticOptions); 30 | 31 | invoke('files:remove-generated'); 32 | invoke('deploy:vendors'); 33 | invoke('config:remove-dev-modules'); 34 | invoke('files:generate'); 35 | invoke('artifact:package'); 36 | })->local(); 37 | 38 | desc('Deploy artifact'); 39 | task('deploy-artifact', [ 40 | 'deploy:info', 41 | 'deploy:prepare', 42 | 'deploy:lock', 43 | 'deploy:release', 44 | 'artifact:upload', 45 | 'artifact:extract', 46 | 'deploy:clear_paths', 47 | 'deploy:shared', 48 | 'deploy:writable', 49 | 'maintenance:set:if-needed', 50 | 'cache:clear:if-maintenance', 51 | 'database:upgrade', 52 | 'config:import', 53 | //'crontab:update', 54 | 'deploy:override_shared', 55 | 'deploy:symlink', 56 | 'maintenance:unset', 57 | 'cache:clear', 58 | 'cache:enable', 59 | 'deploy:unlock', 60 | 'cleanup', 61 | 'success', 62 | ]); 63 | fail('deploy-artifact', 'deploy:failed'); 64 | 65 | # ---- Deployment Flow 66 | desc('Deploy project'); 67 | task('deploy', [ 68 | 'deploy:info', 69 | 'deploy:prepare', 70 | 'deploy:lock', 71 | 'deploy:release', 72 | 'deploy:update_code', 73 | 'deploy:vendors', 74 | 'config:remove-dev-modules', 75 | 'deploy:clear_paths', 76 | 'deploy:shared', 77 | 'deploy:writable', 78 | 'files:generate', 79 | 'maintenance:set:if-needed', 80 | 'cache:clear:if-maintenance', 81 | 'database:upgrade', 82 | 'config:import', 83 | //'crontab:update', 84 | 'deploy:override_shared', 85 | 'deploy:symlink', 86 | 'maintenance:unset', 87 | 'cache:clear', 88 | 'cache:enable', 89 | 'deploy:unlock', 90 | 'cleanup', 91 | 'success', 92 | ]); 93 | -------------------------------------------------------------------------------- /recipe/magento_2_2/artifact.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | set('artifact_file', 'artifact.tar.gz'); 14 | set('artifact_dir', 'artifacts'); 15 | set('artifact_excludes_file', __DIR__ . '/../../config/artifact.excludes'); 16 | 17 | set('artifact_path', function () { 18 | if (!test('[ -d {{artifact_dir}} ]')) { 19 | run('mkdir {{artifact_dir}}'); 20 | } 21 | return get('artifact_dir') . '/' . get('artifact_file'); 22 | }); 23 | 24 | task('artifact:package', 'tar --exclude-from={{artifact_excludes_file}} -czf {{artifact_path}} .'); 25 | 26 | task('artifact:upload', function () { 27 | upload(get('artifact_path'), '{{release_path}}'); 28 | }); 29 | 30 | task('artifact:extract', ' 31 | tar -xzpf {{release_path}}/{{artifact_file}} -C {{release_path}}; 32 | rm -rf {{release_path}}/{{artifact_file}} 33 | '); 34 | -------------------------------------------------------------------------------- /recipe/magento_2_2/config.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | use Deployer\Exception\RuntimeException; 14 | use Symfony\Component\Process\Exception\ProcessFailedException; 15 | 16 | const OUTPUT_CONFIG_IMPORT_NEEDED = 'This command is unavailable right now. ' . 17 | 'To continue working with it please run app:config:import or setup:upgrade command before.'; 18 | 19 | set('config_import_needed', function () { 20 | try { 21 | // NOTE: Workaround until "app:config:status" is available on Magento 2.2.3 22 | run('{{bin/php}} {{release_path}}/{{magento_bin}} config:set workaround/check/config_status 1'); 23 | } catch (ProcessFailedException $e) { 24 | if (trim($e->getProcess()->getOutput()) == OUTPUT_CONFIG_IMPORT_NEEDED) { 25 | return true; 26 | } 27 | } catch (RuntimeException $e) { 28 | if (trim($e->getOutput()) == OUTPUT_CONFIG_IMPORT_NEEDED) { 29 | return true; 30 | } 31 | } 32 | return false; 33 | }); 34 | 35 | task('config:import', function () { 36 | get('config_import_needed') ? 37 | run('{{bin/php}} {{release_path}}/{{magento_bin}} app:config:import --no-interaction') : 38 | writeln('Skipped -> App config is up to date'); 39 | }); 40 | 41 | /* 42 | * In dev_modules, Magento modules can be specified that should be removed from app/etc/config.php during deployment 43 | * Modules installed with "require-dev" that are present in app/etc/config.php must be added here to prevent problems 44 | * with bin/magento setup:db:status 45 | */ 46 | set('dev_modules', []); 47 | 48 | desc('Remove dev_modules modules from app/etc/config.php'); 49 | task('config:remove-dev-modules', function () { 50 | $modules = get('dev_modules'); 51 | if (!empty($modules)) { 52 | $configFile = get('magento_dir') . '/app/etc/config.php'; 53 | $config = include $configFile; 54 | foreach ($modules as $module) { 55 | if (isset($config['modules'][$module])) { 56 | unset($config['modules'][$module]); 57 | writeln('Removed: ' . $module); 58 | } else { 59 | writeln('Not installed: ' . $module); 60 | } 61 | } 62 | $updatedConfig = " {{release_path}}/$configFile $updatedConfigEof"); 65 | } 66 | }); 67 | -------------------------------------------------------------------------------- /recipe/magento_2_2/crontab.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | task('crontab:update', function () { 14 | if (test('[ -L {{deploy_path}}/current ]')) { 15 | run("{{bin/php}} {{current_path}}/{{magento_bin}} cron:remove"); 16 | } 17 | run("{{bin/php}} {{release_path}}/{{magento_bin}} cron:install"); 18 | }); 19 | -------------------------------------------------------------------------------- /recipe/magento_2_2/database.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | use Deployer\Exception\RuntimeException; 14 | use Symfony\Component\Process\Exception\ProcessFailedException; 15 | 16 | const DB_UPDATE_NEEDED_EXIT_CODE = 2; 17 | 18 | set('database_upgrade_needed', function () { 19 | try { 20 | run('{{bin/php}} {{release_path}}/{{magento_bin}} setup:db:status'); 21 | } catch (ProcessFailedException $e) { 22 | if ($e->getProcess()->getExitCode() == DB_UPDATE_NEEDED_EXIT_CODE) { 23 | return true; 24 | } 25 | throw $e; 26 | } catch (RuntimeException $e) { 27 | if ($e->getExitCode() == DB_UPDATE_NEEDED_EXIT_CODE) { 28 | return true; 29 | } 30 | throw $e; 31 | } 32 | return false; 33 | }); 34 | 35 | task('database:upgrade', function () { 36 | if (get('database_upgrade_needed')) { 37 | run('{{bin/php}} {{release_path}}/{{magento_bin}} setup:db-schema:upgrade --no-interaction'); 38 | run('{{bin/php}} {{release_path}}/{{magento_bin}} setup:db-data:upgrade --no-interaction'); 39 | } else { 40 | writeln('Skipped -> All Modules are up to date'); 41 | } 42 | }); 43 | -------------------------------------------------------------------------------- /recipe/magento_2_2/files.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | task('maintenance:set:if-needed', function () { 14 | get('database_upgrade_needed') || get('config_import_needed') ? 15 | invoke('maintenance:set') : 16 | writeln('Skipped -> Maintenance is not needed'); 17 | }); 18 | -------------------------------------------------------------------------------- /recipe/magento_2_2/rollback.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | use Deployer\Exception\Exception; 14 | 15 | task('rollback:validate', function () { 16 | $releases = get('releases_list'); 17 | 18 | if (!isset($releases[1])) { 19 | writeln("No more releases you can revert to."); 20 | return; 21 | } 22 | 23 | set('release_path', "{{deploy_path}}/releases/{$releases[1]}"); 24 | if (get('database_upgrade_needed') || get('config_import_needed')) { 25 | $errorMessage = 'Secure rollback not possible' . PHP_EOL . PHP_EOL; 26 | $errorMessage .= 'Previous release not compatible with current DB Schema' . PHP_EOL; 27 | $errorMessage .= 'You can still do a manual rollback at your own risk' . PHP_EOL; 28 | throw new Exception($errorMessage); 29 | } 30 | 31 | writeln('Validation successful: Previous release is compatible with DB Schema'); 32 | }); 33 | -------------------------------------------------------------------------------- /recipe/magento_2_2_5.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | require_once 'recipe/common.php'; 14 | require_once __DIR__ . '/magento_2_2.php'; 15 | require_once __DIR__ . '/magento_2_2_5/config.php'; 16 | -------------------------------------------------------------------------------- /recipe/magento_2_2_5/config.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | use Deployer\Exception\RuntimeException; 14 | use Symfony\Component\Process\Exception\ProcessFailedException; 15 | 16 | const CONFIG_IMPORT_NEEDED_EXIT_CODE = 2; 17 | 18 | set('config_import_needed', function () { 19 | try { 20 | run('{{bin/php}} {{release_path}}/{{magento_bin}} app:config:status'); 21 | } catch (ProcessFailedException $e) { 22 | if ($e->getProcess()->getExitCode() == CONFIG_IMPORT_NEEDED_EXIT_CODE) { 23 | return true; 24 | } 25 | throw $e; 26 | } catch (RuntimeException $e) { 27 | if ($e->getExitCode() == CONFIG_IMPORT_NEEDED_EXIT_CODE) { 28 | return true; 29 | } 30 | throw $e; 31 | } 32 | return false; 33 | }); 34 | -------------------------------------------------------------------------------- /recipe/magento_2_2_x/crontab.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * For the full copyright and license information, please view the LICENSE 8 | * file that was distributed with this source code. 9 | */ 10 | 11 | namespace Deployer; 12 | 13 | task('crontab:update', '{{bin/php}} {{magento_bin}} cron:install --force'); 14 | --------------------------------------------------------------------------------