Skip to content

Commit 0c06c62

Browse files
Run docgen
1 parent 7b20fa6 commit 0c06c62

1 file changed

Lines changed: 31 additions & 23 deletions

File tree

docs/recipe/magento2.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ true
380380

381381

382382
### artifact_file
383-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L378)
383+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L385)
384384

385385
Artifact deployment section
386386
The 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#L381)
394+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L388)
395395

396396
The 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#L385)
404+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L392)
405405

406406
Points to a file with a list of files to exclude from packaging.
407407
The 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#L388)
415+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L395)
416416

417417
If 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#L391)
425+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L398)
426426

427427
Overrides [repository](/docs/recipe/common.md#repository) from `recipe/common.php`.
428428

@@ -434,7 +434,7 @@ null
434434

435435

436436
### artifact_path
437-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L394)
437+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L401)
438438

439439
The 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#L402)
450+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L409)
451451

452452
The 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#L474)
461+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L481)
462462

463463
Array 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#L476)
468+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L483)
469469

470470
Array of shared directories that will be added to the default shared_dirs without overriding
471471

@@ -639,48 +639,56 @@ This task is group task which contains next tasks:
639639
* [deploy:publish](/docs/recipe/common.md#deploy-publish)
640640

641641

642+
### deploy\:magento\:failed {#deploy-magento-failed}
643+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L377)
644+
645+
Run magento post deployment failure tasks.
646+
647+
Run Magento Deployment Failure Tasks
648+
649+
642650
### artifact\:package {#artifact-package}
643-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L413)
651+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L420)
644652

645653
Packages all relevant files in an artifact.
646654

647655
tasks section
648656

649657

650658
### artifact\:upload {#artifact-upload}
651-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L423)
659+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L430)
652660

653661
Uploads artifact in release folder for extraction.
654662

655663

656664

657665

658666
### artifact\:extract {#artifact-extract}
659-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L428)
667+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L435)
660668

661669
Extracts artifact in release path.
662670

663671

664672

665673

666674
### build\:remove-generated {#build-remove-generated}
667-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L434)
675+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L441)
668676

669677
Clears generated files prior to building.
670678

671679

672680

673681

674682
### build\:prepare {#build-prepare}
675-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L439)
683+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L446)
676684

677685
Prepare local artifact build.
678686

679687

680688

681689

682690
### artifact\:build {#artifact-build}
683-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L464)
691+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L471)
684692

685693
Builds an artifact.
686694

@@ -697,15 +705,15 @@ This task is group task which contains next tasks:
697705

698706

699707
### deploy\:additional-shared {#deploy-additional-shared}
700-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L480)
708+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L487)
701709

702710
Adds additional files and dirs to the list of shared files and dirs.
703711

704712

705713

706714

707715
### magento\:set_cache_prefix {#magento-set_cache_prefix}
708-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L495)
716+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L502)
709717

710718
Update cache id_prefix.
711719

@@ -719,15 +727,15 @@ after('deploy:magento', 'magento:cleanup_cache_prefix');
719727

720728

721729
### magento\:cleanup_cache_prefix {#magento-cleanup_cache_prefix}
722-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L535)
730+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L542)
723731

724732
Cleanup cache id_prefix env files.
725733

726734
After successful deployment, move the tmp_env.php file to env.php ready for next deployment
727735

728736

729737
### magento\:cron\:stop {#magento-cron-stop}
730-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L551)
738+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L558)
731739

732740
Remove cron from crontab and kill running cron jobs.
733741

@@ -739,7 +747,7 @@ To use this feature, add the following to your deployer scripts:
739747

740748

741749
### magento\:cron\:install {#magento-cron-install}
742-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L567)
750+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L574)
743751

744752
Install cron in crontab.
745753

@@ -751,7 +759,7 @@ To use this feature, add the following to your deployer scripts:
751759

752760

753761
### artifact\:prepare {#artifact-prepare}
754-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L573)
762+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L580)
755763

756764
Prepares an artifact on the target server.
757765

@@ -771,7 +779,7 @@ This task is group task which contains next tasks:
771779

772780

773781
### artifact\:finish {#artifact-finish}
774-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L586)
782+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L593)
775783

776784
Executes the tasks after artifact is released.
777785

@@ -787,7 +795,7 @@ This task is group task which contains next tasks:
787795

788796

789797
### artifact\:deploy {#artifact-deploy}
790-
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L595)
798+
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L602)
791799

792800
Actually releases the artifact deployment.
793801

0 commit comments

Comments
 (0)