Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

incorporate magento_dir for #3843 #3846

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
+42 −33
Open

incorporate magento_dir for #3843 #3846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a813d90
fix typo in magento recipe
Feb 21, 2023
fc2d5ae
Merge branch 'deployphp:master' into master
Mar 6, 2023
ec0e1ba
Merge branch 'deployphp:master' into master
Mar 8, 2023
a69b268
Merge branch 'deployphp:master' into master
Mar 27, 2023
381b656
Merge branch 'deployphp:master' into master
Apr 19, 2024
e4c708c
Merge branch 'deployphp:master' into master
Apr 22, 2024
2663525
process the correct theme names and add -f switch here as well
Apr 22, 2024
9cd6b54
run docgen
Apr 22, 2024
e0d1c2b
commit the other changed doc files after running bin/docgen
Apr 22, 2024
bbb9470
Revert "commit the other changed doc files after running bin/docgen"
Apr 22, 2024
015ebb4
Merge branch 'deployphp:master' into master
May 23, 2024
63083c5
use magento_dir in deploy assets command
Jun 10, 2024
28eacbe
use magento_dir when installing vendor folder
Jun 10, 2024
0ea18c5
bin/docgen
Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions docs/recipe/magento2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ true


### artifact_file
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L345)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L354)

The file the artifact is saved to

Expand All @@ -363,7 +363,7 @@ The file the artifact is saved to


### artifact_dir
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L348)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L357)

The directory the artifact is saved in

Expand All @@ -373,7 +373,7 @@ The directory the artifact is saved in


### artifact_excludes_file
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L352)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L361)

Points to a file with a list of files to exclude from packaging.
The format is as with the `tar --exclude-from=[file]` option
Expand All @@ -384,7 +384,7 @@ The format is as with the `tar --exclude-from=[file]` option


### build_from_repo
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L355)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L364)

If set to true, the artifact is built from a clean copy of the project repository instead of the current working directory

Expand All @@ -394,7 +394,7 @@ false


### repository
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L358)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L367)

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

Expand All @@ -406,7 +406,7 @@ null


### artifact_path
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L361)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L370)

The relative path to the artifact file. If the directory does not exist, it will be created

Expand All @@ -419,7 +419,7 @@ return get('artifact_dir') . '/' . get('artifact_file');


### bin/tar
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L369)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L378)

The location of the tar command. On MacOS you should have installed gtar, as it supports the required settings
:::info Autogenerated
Expand All @@ -430,14 +430,14 @@ The value of this configuration is autogenerated on access.


### additional_shared_files
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L441)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L450)

Array of shared files that will be added to the default shared_files without overriding



### additional_shared_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L443)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L452)

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

Expand Down Expand Up @@ -510,55 +510,55 @@ Syncs content version.


### magento:maintenance:enable
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L273)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L282)

Enables maintenance mode.




### magento:maintenance:disable
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L279)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L288)

Disables maintenance mode.




### magento:maintenance:enable-if-needed
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L285)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L294)

Set maintenance mode if needed.




### magento:config:import
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L292)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L301)

Config Import.




### magento:upgrade:db
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L301)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L310)

Upgrades magento database.




### magento:cache:flush
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L311)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L320)

Flushes Magento Cache.




### deploy:magento
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L316)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L325)

Magento2 deployment operations.

Expand All @@ -575,7 +575,7 @@ This task is group task which contains next tasks:


### magento:build
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L326)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L335)

Magento2 build operations.

Expand All @@ -588,7 +588,7 @@ This task is group task which contains next tasks:


### deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L332)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L341)

Deploys your project.

Expand All @@ -604,47 +604,47 @@ This task is group task which contains next tasks:


### artifact:package
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L380)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L389)

Packages all relevant files in an artifact.




### artifact:upload
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L390)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L399)

Uploads artifact in release folder for extraction.




### artifact:extract
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L395)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L404)

Extracts artifact in release path.




### build:remove-generated
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L401)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L410)

Clears generated files prior to building.




### build:prepare
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L406)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L415)

Prepare local artifact build.




### artifact:build
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L431)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L440)

Builds an artifact.

Expand All @@ -661,15 +661,15 @@ This task is group task which contains next tasks:


### deploy:additional-shared
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L447)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L456)

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




### magento:set_cache_prefix
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L462)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L471)

Update cache id_prefix.

Expand All @@ -683,15 +683,15 @@ after('deploy:magento', 'magento:cleanup_cache_prefix');


### magento:cleanup_cache_prefix
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L502)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L511)

Cleanup cache id_prefix env files.

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


### magento:cron:stop
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L518)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L527)

Remove cron from crontab and kill running cron jobs.

Expand All @@ -703,7 +703,7 @@ To use this feature, add the following to your deployer scripts:


### magento:cron:install
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L534)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L543)

Install cron in crontab.

Expand All @@ -715,7 +715,7 @@ To use this feature, add the following to your deployer scripts:


### artifact:prepare
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L540)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L549)

Prepares an artifact on the target server.

Expand All @@ -735,7 +735,7 @@ This task is group task which contains next tasks:


### artifact:finish
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L553)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L562)

Executes the tasks after artifact is released.

Expand All @@ -750,7 +750,7 @@ This task is group task which contains next tasks:


### artifact:deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L562)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/magento2.php#L571)

Actually releases the artifact deployment.

Expand Down
11 changes: 10 additions & 1 deletion recipe/magento2.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
$themesToCompile .= ' -t ' . $theme;
}
}
run("{{bin/php}} {{release_or_current_path}}/bin/magento setup:static-content:deploy -f --content-version={{content_version}} {{static_deploy_options}} {{static_content_locales}} $themesToCompile -j {{static_content_jobs}}");
run("{{bin/php}} {{release_or_current_path}}/{{magento_dir}}/bin/magento setup:static-content:deploy -f --content-version={{content_version}} {{static_deploy_options}} {{static_content_locales}} $themesToCompile -j {{static_content_jobs}}");
}
});

Expand Down Expand Up @@ -269,6 +269,15 @@ function magentoDeployAssetsSplit(string $area)

before('magento:deploy:assets', 'magento:sync:content_version');

before('deploy:vendors', function(){
set('original_release_or_current_path',get('release_or_current_path'));
set('release_or_current_path', get('release_or_current_path') .'/'. get('magento_dir'));
});

after('deploy:vendors', function (){
set('release_or_current_path', get('original_release_or_current_path'));
});

desc('Enables maintenance mode');
task('magento:maintenance:enable', function () {
// do not use {{bin/magento}} because it would be in "release" but the maintenance mode must be set in "current"
Expand Down
Loading