380380
381381
382382# ## artifact_file
383- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L363 )
383+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L378 )
384384
385385Artifact deployment section
386386The file the artifact is saved to
@@ -391,7 +391,7 @@ The file the artifact is saved to
391391
392392
393393# ## artifact_dir
394- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L366 )
394+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L381 )
395395
396396The directory the artifact is saved in
397397
@@ -401,7 +401,7 @@ The directory the artifact is saved in
401401
402402
403403# ## artifact_excludes_file
404- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L370 )
404+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L385 )
405405
406406Points to a file with a list of files to exclude from packaging.
407407The format is as with the `tar --exclude-from=[file]` option
@@ -412,7 +412,7 @@ The format is as with the `tar --exclude-from=[file]` option
412412
413413
414414# ## build_from_repo
415- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L373 )
415+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L388 )
416416
417417If set to true, the artifact is built from a clean copy of the project repository instead of the current working directory
418418
@@ -422,7 +422,7 @@ false
422422
423423
424424# ## repository
425- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L376 )
425+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L391 )
426426
427427Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`.
428428
434434
435435
436436# ## artifact_path
437- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L379 )
437+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L394 )
438438
439439The relative path to the artifact file. If the directory does not exist, it will be created
440440
@@ -447,7 +447,7 @@ return get('artifact_dir') . '/' . get('artifact_file');
447447
448448
449449# ## bin/tar
450- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L387 )
450+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L402 )
451451
452452The location of the tar command. On MacOS you should have installed gtar, as it supports the required settings
453453:::info Autogenerated
@@ -458,14 +458,14 @@ The value of this configuration is autogenerated on access.
458458
459459
460460# ## additional_shared_files
461- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L459 )
461+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L474 )
462462
463463Array of shared files that will be added to the default shared_files without overriding
464464
465465
466466
467467# ## additional_shared_dirs
468- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L461 )
468+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L476 )
469469
470470Array of shared directories that will be added to the default shared_dirs without overriding
471471
@@ -531,71 +531,71 @@ Deploys assets for frontend only.
531531
532532
533533# ## magento\:sync\:content_version {#magento-sync-content_version}
534- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L269 )
534+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L284 )
535535
536536Syncs content version.
537537
538538
539539
540540
541541# ## magento\:maintenance\:enable {#magento-maintenance-enable}
542- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L279 )
542+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L294 )
543543
544544Enables maintenance mode.
545545
546546
547547
548548
549549# ## magento\:maintenance\:disable {#magento-maintenance-disable}
550- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L285 )
550+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L300 )
551551
552552Disables maintenance mode.
553553
554554
555555
556556
557557# ## magento\:maintenance\:enable-if-needed {#magento-maintenance-enable-if-needed}
558- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L291 )
558+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L306 )
559559
560560Set maintenance mode if needed.
561561
562562
563563
564564
565565# ## magento\:config\:import {#magento-config-import}
566- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L298 )
566+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L313 )
567567
568568Config Import.
569569
570570
571571
572572
573573# ## magento\:upgrade\:db {#magento-upgrade-db}
574- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L307 )
574+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L322 )
575575
576576Upgrades magento database.
577577
578578
579579
580580
581581# ## magento\:upgrade {#magento-upgrade}
582- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L319 )
582+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L334 )
583583
584584Run upgrades if needed.
585585
586586
587587
588588
589589# ## magento\:cache\:flush {#magento-cache-flush}
590- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L328 )
590+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L343 )
591591
592592Flushes Magento Cache.
593593
594594
595595
596596
597597# ## deploy\:magento {#deploy-magento}
598- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L333 )
598+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L348 )
599599
600600Magento2 deployment operations.
601601
@@ -611,7 +611,7 @@ This task is group task which contains next tasks:
611611
612612
613613# ## magento\:build {#magento-build}
614- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L342 )
614+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L357 )
615615
616616Magento2 build operations.
617617
@@ -624,7 +624,7 @@ This task is group task which contains next tasks:
624624
625625
626626# ## deploy {#deploy}
627- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L348 )
627+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L363 )
628628
629629Deploys your project.
630630
@@ -640,47 +640,47 @@ This task is group task which contains next tasks:
640640
641641
642642# ## artifact\:package {#artifact-package}
643- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L398 )
643+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L413 )
644644
645645Packages all relevant files in an artifact.
646646
647647tasks section
648648
649649
650650# ## artifact\:upload {#artifact-upload}
651- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L408 )
651+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L423 )
652652
653653Uploads artifact in release folder for extraction.
654654
655655
656656
657657
658658# ## artifact\:extract {#artifact-extract}
659- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L413 )
659+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L428 )
660660
661661Extracts artifact in release path.
662662
663663
664664
665665
666666# ## build\:remove-generated {#build-remove-generated}
667- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L419 )
667+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L434 )
668668
669669Clears generated files prior to building.
670670
671671
672672
673673
674674# ## build\:prepare {#build-prepare}
675- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L424 )
675+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L439 )
676676
677677Prepare local artifact build.
678678
679679
680680
681681
682682# ## artifact\:build {#artifact-build}
683- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L449 )
683+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L464 )
684684
685685Builds an artifact.
686686
@@ -697,15 +697,15 @@ This task is group task which contains next tasks:
697697
698698
699699# ## deploy\:additional-shared {#deploy-additional-shared}
700- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L465 )
700+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L480 )
701701
702702Adds additional files and dirs to the list of shared files and dirs.
703703
704704
705705
706706
707707# ## magento\:set_cache_prefix {#magento-set_cache_prefix}
708- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L480 )
708+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L495 )
709709
710710Update cache id_prefix.
711711
@@ -719,15 +719,15 @@ after('deploy:magento', 'magento:cleanup_cache_prefix');
719719
720720
721721# ## magento\:cleanup_cache_prefix {#magento-cleanup_cache_prefix}
722- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L520 )
722+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L535 )
723723
724724Cleanup cache id_prefix env files.
725725
726726After successful deployment, move the tmp_env.php file to env.php ready for next deployment
727727
728728
729729# ## magento\:cron\:stop {#magento-cron-stop}
730- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L536 )
730+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L551 )
731731
732732Remove cron from crontab and kill running cron jobs.
733733
@@ -739,7 +739,7 @@ To use this feature, add the following to your deployer scripts:
739739
740740
741741# ## magento\:cron\:install {#magento-cron-install}
742- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L552 )
742+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L567 )
743743
744744Install cron in crontab.
745745
@@ -751,7 +751,7 @@ To use this feature, add the following to your deployer scripts:
751751
752752
753753# ## artifact\:prepare {#artifact-prepare}
754- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L558 )
754+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L573 )
755755
756756Prepares an artifact on the target server.
757757
@@ -771,7 +771,7 @@ This task is group task which contains next tasks:
771771
772772
773773# ## artifact\:finish {#artifact-finish}
774- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L571 )
774+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L586 )
775775
776776Executes the tasks after artifact is released.
777777
@@ -787,7 +787,7 @@ This task is group task which contains next tasks:
787787
788788
789789# ## artifact\:deploy {#artifact-deploy}
790- [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L580 )
790+ [Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L595 )
791791
792792Actually releases the artifact deployment.
793793
0 commit comments