mirror_php/deployer
1
0
Fork 0
mirror of https://github.com/deployphp/deployer.git synced 2025-01-17 21:48:58 +01:00
Code Issues Projects Releases Wiki Activity

Improve recipe

Browse Source
This commit is contained in:
Dr. Ulrich Thomas Gabor 2023-10-24 17:06:56 +02:00 committed by GitHub
parent 003b4e52d9
commit 7f905c2155
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/recipe/shopware.md
View File

@ -29,11 +29,11 @@ You can read more about Deployer in [Getting Started](/docs/getting-started.md).
The [deploy](#deploy) task of **Shopware** consists of:
* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release
* [deploy:info](/docs/recipe/typo3.md#deployinfo) –
* [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment
* [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy
* [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy
* [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release
* [deploy:update_code](/docs/recipe/typo3.md#deployupdate_code) –
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code
* [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs
* [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs
* [sw:deploy](/docs/recipe/shopware.md#swdeploy) –
@ -41,7 +41,6 @@ The [deploy](#deploy) task of **Shopware** consists of:
* [sw:plugin:refresh](/docs/recipe/shopware.md#swpluginrefresh) –
* [sw:theme:refresh](/docs/recipe/shopware.md#swthemerefresh) –
* [sw:scheduled-task:register](/docs/recipe/shopware.md#swscheduled-taskregister) –
* [sw:theme:compile](/docs/recipe/shopware.md#swthemecompile) –
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear) –
* [sw:plugin:update:all](/docs/recipe/shopware.md#swpluginupdateall) –
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear) –
@ -68,10 +67,13 @@ set('repository', 'git@github.com:shopware/production.git');
configure host:
host('SSH-HOSTNAME')
->setRemoteUser('SSH-USER')
->set('remote_user', 'SSH-USER')
->set('deploy_path', '/var/www/shopware') // This is the path, where deployer will create its directory structure
->set('http_user', 'www-data') // Not needed, if the `user` is the same user, the webserver is running with
->set('writable_mode', 'chmod');
->set('http_user', 'www-data') // Not needed, if the `user` is the same user, the webserver is running with
->set('http_group', 'www-data')
->set('writable_mode', 'chmod')
->set('writable_recursive', true)
->set('become', 'www-data'); // You might want to change user to execute remote tasks because of access rights of created cache files
:::note
Please remember that the installation must be modified so that it can be
@ -81,7 +83,7 @@ Please remember that the installation must be modified so that it can be
## Configuration
### bin/console
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L30)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L32)
@ -91,7 +93,7 @@ Please remember that the installation must be modified so that it can be
### default_timeout
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L32)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L34)
Overrides [default_timeout](/docs/recipe/common.md#default_timeout) from `recipe/common.php`.
@ -214,15 +216,16 @@ This task remotely executes the `database:migrate` console command on the target
### sw:theme:compile
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L100)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L102)
This task is not used per default, but can be used, e.g. in combination with `SHOPWARE_SKIP_THEME_COMPILE=1`,
to build the theme remotely instead of locally.
### sw:plugin:update:all
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L136)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L138)
@ -230,7 +233,7 @@ This task remotely executes the `database:migrate` console command on the target
### sw:writable:jwt
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L146)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L148)
@ -238,11 +241,11 @@ This task remotely executes the `database:migrate` console command on the target
### sw:deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L154)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L155)
Grouped SW deploy tasks.
This task is group task which contains next tasks:
@ -250,7 +253,6 @@ This task is group task which contains next tasks:
* [sw:plugin:refresh](/docs/recipe/shopware.md#swpluginrefresh)
* [sw:theme:refresh](/docs/recipe/shopware.md#swthemerefresh)
* [sw:scheduled-task:register](/docs/recipe/shopware.md#swscheduled-taskregister)
* [sw:theme:compile](/docs/recipe/shopware.md#swthemecompile)
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear)
* [sw:plugin:update:all](/docs/recipe/shopware.md#swpluginupdateall)
* [sw:cache:clear](/docs/recipe/shopware.md#swcacheclear)
@ -290,7 +292,7 @@ This task is group task which contains next tasks:
### sw-build-without-db
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L193)
[Source](https://github.com/deployphp/deployer/blob/master/recipe/shopware.php#L192)

19
recipe/shopware.php
View File

@ -10,10 +10,13 @@
*
* configure host:
* host('SSH-HOSTNAME')
* ->setRemoteUser('SSH-USER')
* ->set('remote_user', 'SSH-USER')
* ->set('deploy_path', '/var/www/shopware') // This is the path, where deployer will create its directory structure
* ->set('http_user', 'www-data') // Not needed, if the `user` is the same user, the webserver is running with
* ->set('writable_mode', 'chmod');
* ->set('http_user', 'www-data') // Not needed, if the `user` is the same user, the webserver is running with
* ->set('http_group', 'www-data')
* ->set('writable_mode', 'chmod')
* ->set('writable_recursive', true)
* ->set('become', 'www-data'); // You might want to change user to execute remote tasks because of access rights of created cache files
*
* :::note
* Please remember that the installation must be modified so that it can be
@ -22,7 +25,6 @@
*/
namespace Deployer;
require_once __DIR__ . '/common.php';
add('recipes', ['shopware']);
@ -31,8 +33,6 @@ set('bin/console', '{{bin/php}} {{release_or_current_path}}/bin/console');
set('default_timeout', 3600); // Increase when tasks take longer than that.
//set host configuration and repository here
// These files are shared among all releases.
set('shared_files', [
'.env',
@ -97,6 +97,8 @@ task('sw:theme:refresh', function () {
run('cd {{release_path}} && {{bin/console}} theme:refresh');
});
// This task is not used per default, but can be used, e.g. in combination with `SHOPWARE_SKIP_THEME_COMPILE=1`,
// to build the theme remotely instead of locally.
task('sw:theme:compile', function () {
run('cd {{release_path}} && {{bin/console}} theme:compile');
});
@ -150,13 +152,11 @@ task('sw:writable:jwt', static function () {
/**
* Grouped SW deploy tasks.
*/
task('sw:deploy', [
'sw:database:migrate',
'sw:plugin:refresh',
'sw:theme:refresh',
'sw:scheduled-task:register',
'sw:theme:compile',
'sw:cache:clear',
'sw:plugin:update:all',
'sw:cache:clear',
@ -186,10 +186,9 @@ task('sw-build-without-db:get-remote-config', static function () {
});
task('sw-build-without-db:build', static function () {
runLocally('CI=1 SHOPWARE_SKIP_BUNDLE_DUMP=1 SHOPWARE_SKIP_THEME_COMPILE=1 bin/build-js.sh');
runLocally('CI=1 SHOPWARE_SKIP_BUNDLE_DUMP=1 ./bin/build-js.sh');
});
task('sw-build-without-db', [
'sw-build-without-db:get-remote-config',
'sw-build-without-db:build',